cyberneticlibrary

Audit documentation quality comprehensively

[FRG]-docs-auditcommandsetup L20
nxtg-ai/forge
What it does

Audit documentation coverage, freshness, and quality

Best for

Identifying documentation debt and stale docs before they impact new contributors

Inputs
  • · TypeScript source files
  • · Markdown documentation files
Outputs
  • · coverage percentage
  • · freshness report
  • · link validation results
  • · code example validation
  • · audit report with recommendations
Requires
  • · grep
  • · find
  • · stat
Preconditions
  • · documentation files exist
  • · src/ directory present
Failure modes
  • · large codebase exhausts tool limits
  • · missing docs/ directory
  • · code examples reference nonexistent functions
Trust signals
  • · uses both static grep counts and link validation
  • · compares current vs. expected key files
  • · timestamps old files for freshness analysis