Ensures documentation is accurate, complete, and actually works — catches documentation rot before users hit it. Validates code examples, checks links, compares API/CLI docs against reality, detects stale docs, and scores completeness.
Catches documentation rot before users hit it. Validates everything: code examples actually run, links resolve, API docs match reality, CLI flags exist, and docs stay fresh.
Scripts: ~/openclaw/skills/doc-verifier/scripts/
Binary: ~/bin/doc-verifier
S=~/openclaw/skills/doc-verifier/scripts
# Full review of a project
doc-verifier ~/my-project
# Quick check (links + freshness only)
doc-verifier ~/my-project --quick
# Full audit including code execution
doc-verifier ~/my-project --full
# With API comparison
doc-verifier ~/my-project --api-url http://localhost:3000
# With CLI comparison
doc-verifier ~/my-project --cli-cmd "node ~/my-project/cli.js"
# Output to separate directory
doc-verifier ~/my-project --output-dir /tmp/doc-review
# JSON format
doc-verifier ~/my-project --format json
# Compare with previous review
doc-verifier ~/my-project --compare /tmp/previous-review
# Individual scripts
node $S/links.cjs ~/my-project
node $S/freshness.cjs ~/my-project
node $S/completeness.cjs ~/my-project
node $S/examples.cjs ~/my-project
node $S/api-docs.cjs ~/my-project --api-url http://localhost:3000
node $S/cli-docs.cjs ~/my-project --cli-cmd "mycli"
node $S/report.cjs /tmp/output-dir --format md
examples.cjs — Code Example ValidatorExtracts fenced code blocks from markdown and executes them:
<!-- skip-verify --> or data blocks (text, json, yaml, etc.)examples-report.jsonlinks.cjs — Link Checkerlinks-report.jsonapi-docs.cjs — API Documentation vs Realityapi-docs-report.jsoncli-docs.cjs — CLI Documentation Checker--help on actual CLIcli-docs-report.jsonfreshness.cjs — Documentation Freshnessfreshness-report.jsoncompleteness.cjs — Documentation Completenesscompleteness-report.jsonreview.cjs — Full Audit OrchestratorOptions: --quick, --full, --api-url, --cli-cmd, --no-execute, --output-dir, --compare, --format md|json
report.cjs — Report Generatordoc-health-report.md or doc-health-report.jsonNode.js built-in modules only. No npm install required.
All reports are JSON. The final report is also available as markdown. Health Score ranges from 0-100.