compiling-project-docs

What problem does it solve?

This skill converts a concise CLAUDE.md into a structured docs directory so agents can progressively load detailed project information without overloading the main CLAUDE.md. It prevents scattershot, ad hoc documentation and ensures consistent, discoverable references for architecture, APIs, testing, deployment, and workflow.

Core Features & Use Cases

• Pre-flight validation: confirms repository is a git repo and that CLAUDE.md exists before any files are created, failing fast with clear operator guidance.
• Topic detection & overrides: auto-detects topics from codebase signals with a confidence threshold and respects include/skip or full overrides.
• Content generation with templates: produces ordered documents (architecture, getting-started, topic docs, index) using strict templates and per-document line targets.
• Code-aware output: embeds file paths and code snippets, cross-references documents, and validates link integrity.
• Quality validation & reporting: enforces AI context summaries, checks for placeholders, validates line counts, and reports document counts and cross-reference metrics.
• Use case: generate a docs/ set for a legacy repository so planner and builder agents can access component-level details on demand.

Quick Start

Run /compiling-project-settings first then generate the docs directory from CLAUDE.md to produce architecture, getting-started, topic-specific documents, and an index with code snippets and validated cross-references.