Files

6 lines
915 B
Markdown

# Documentation audit reports
Run `python3 scripts/docs_audit.py` before card work. `--force` makes the audit eligible regardless of age. The JSON output lists UTC due status, stored commit validity/reachability, tracked source changes and unresolved local Markdown links. It explicitly reports `semantic_review_performed: false`.
For a due audit, compare changed code with the relevant documents, routes, models, migrations and MCP registrations; inspect tests and record discrepancies. Aim for roughly 20 minutes in recurring audits. Save `YYYY-MM-DD.md` with scope, evidence, checks, findings, unresolved work and whether the review completed. Partial attempts do not advance `last_successful_audit`. Coordinate edits to `.audit-state.json` with other sessions; re-read it immediately before writing and never overwrite a newer successful audit. The state records a completed review, not a passing script run.