codebase-documenter

Codebase documentation auditing scans existing artifacts like root READMEs, architecture diagrams, API references, and inline comments to surface gaps and inconsistencies. This audit-first approach identifies outdated content and missing elements before proposing concrete improvements.

Generating C4 architecture diagrams in Mermaid involves using established templates to structure system context, containers, and components. The process creates consistent, checked-in documentation that visually maps codebase architecture while linking directly to existing reference materials.

Generating consistent READMEs and API references uses official templates like README.template.md and API.template.md to structure content. A proposal phase presents concrete diffs for user approval before applying changes, ensuring existing references are augmented with cross-links rather than duplicated.

Reviewing proposed documentation changes before application is a core phase of the generation process. The system presents concrete diffs and proposals for user approval, ensuring you maintain control over content updates and checked-in documentation modifications before any writing occurs.

Codebase documentation generation preserves Last updated metadata and aligns with Architecture Decision Records (ADRs). It maintains existing reference links, avoids duplicating content across doc-types, and augments current documentation with accurate cross-links to ensure structural consistency.