Skip to content
Apothem
Command pipeline

/docs-review

/docs-review — Documentation review pass against prose-conventions and ten-dimension quality standards.

Role: Docs reviewer Pipeline position: fortress

Documentation review pass against prose-conventions and ten-dimension quality standards.

Canonical invocation

/docs-review

With arguments:

/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]

Inputs

Host repository documentation surface

Outputs

Docs findings at _inputs/docs-review-findings.md

Downstream

The documentation-review stage of the Audit Review Sequence

Workflow phases

The command runs five phases: input ingest, per-page walk, per-finding triage, findings emission, and the validation gate.

Failure modes

SymptomCauseRecovery
Quality gate FAILOutput does not meet standardsFix the output and re-run
Missing input fileNo documentation files are reachable at the pathPass a repository root or docs source directory that contains Markdown pages

Examples

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a repository root
/docs-review path/to/repo/

Cross-references

On this page