doc-gardener

To detect documentation drift after code changes, you can scan the repository docs to identify stale, missing, or unreferenced files. This process surfaces mismatches so maintainers can update repository documentation promptly.

The best way to find missing references in docs/index.md is by running a best-effort index cross-reference check. This scan identifies unreferenced files and flags missing links to reduce unnoticed documentation gaps.

You can scan your docs directory for TODO and FIXME occurrences by running a repository shell script. This lists all TODO and FIXME items for targeted cleanup and remediation.

You need to perform a documentation audit for stale runbooks after a refactor that moves modules, following an API or architecture change, and before releases to ensure documentation accuracy and operational readiness.

This documentation audit approach requires no special dependencies, only access to the repository file tree and basic shell utilities. It performs best-effort index cross-reference checks and TODO/FIXME scans.

To maintain accurate documentation, keep AGENTS.md concise and move details into docs/ and scripts/agent/ directories. This ensures a maintainable documentation structure and reduces unnoticed gaps.