compiling-project-docs

To generate project documentation from a CLAUDE.md file, the skill verifies your git repository, detects codebase topics, and creates a structured docs directory with templated architecture and API documents. It uses progressive disclosure for on-demand agent loading.

Progressive disclosure for codebase documentation prevents overloading a main CLAUDE.md by splitting detailed system architecture, APIs, and deployment workflows into separate topic documents. Agents progressively load these specific references on demand without context saturation.

You can automatically detect documentation topics from codebase signals using built-in topic detection with a confidence threshold. The system respects manual include or skip overrides to ensure the generated docs accurately reflect your repository's architecture.

The documentation generator requires a valid git repository and an existing CLAUDE.md file as mandatory prerequisites. It performs pre-flight validation to fail fast and provide clear operator guidance if these core inputs are missing.

To validate cross-references and line counts in generated docs, the system enforces strict per-document line targets and checks link integrity automatically. It reports document counts and cross-reference metrics while scanning for unresolved placeholders.

The best way to structure agent-readable codebase documentation is generating an ordered docs directory with architecture, getting-started, topic-specific, and index files. This approach embeds file paths and AI context summaries for reliable machine parsing.