doc-update

Documentation audits verify that README files, inline docs, CLI help, and configuration docs reflect the actual codebase by detecting stale, missing, or incorrect content. You can narrow the scope using file paths, directories, globs, or recent changes.

Yes, you can narrow the audit scope by providing file paths, directories, globs, or recent changes. If you omit these parameters, the audit covers all documentation across the entire project.

Filing beads for documentation gaps captures the gap description, current text, code location, file paths, acceptance criteria, and a finding category. This context is generated using bd create to guide fix work.

After identifying and filing beads for documentation gaps, you can optionally dispatch an agent team to implement fixes and synchronize documentation with the current codebase implementation.

A code documentation audit verifies README files, inline docs, CLI help, and configuration docs against the actual codebase. It detects stale, missing, or incorrect content across all these documentation types.

No external dependencies are required to run a documentation gap audit. The tool independently scans project documentation against the codebase and creates beads via bd create for each identified gap.