doc-gardener

What problem does it solve?

Documentation often drifts out of sync with code changes, leaving docs inaccurate, links broken, and operational runbooks stale; doc-gardener helps surface and prioritize those mismatches so maintainers can update the repository documentation promptly.

Core Features & Use Cases

• Scans the docs directory tree and reports missing or unreferenced files to reduce unnoticed documentation gaps.
• Checks docs/index.md for missing references to other docs and lists TODO/FIXME occurrences for targeted cleanup.
• Guidance notes to keep AGENTS.md concise and to move details into docs/ and scripts/agent/ for maintainable documentation structure.
• Use cases: after a refactor that moves modules, following an API or architecture change, and before releases to ensure documentation accuracy.

Quick Start

Run the doc_garden.sh script to scan the docs directory, verify index links, and list any TODO or FIXME items for remediation.