Immutable. This exact content is served forever at /api/v1/blob/0d00413c5ae36e85.
--- name: doc-gen description: "Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen." --- # Doc Gen Generate documentation from source code with structured outlines and Google-style formatting. ## Scoping Before running, ask: 1. **Target**: "Which file or module needs documentation?" 2. **Type**: "What kind of docs?" - Docstrings — Add or update Google-style docstrings - README — Generate a README section for a module - API reference — Generate full API documentation - Overview — High-level module explanation ## MCP Tools | Tool | What It Does | | ---- | ------------ | | `doc_gen` | Generate documentation for a module | | `doc_audit` | Check for stale or missing docs | | `doc_orchestrator` | Full documentation maintenance pipeline | ## Execution For docstring generation: ``` doc_gen(source_path="<target module>") ``` For a full documentation audit first: ``` doc_audit(path="<target>") ``` Then generate docs for gaps found: ``` doc_gen(source_path="<gap file>") ``` For a complete pipeline (audit + generate + review): ``` doc_orchestrator(path="<target>") ``` ## Output Format ```markdown ## Documentation Report **Files:** X | **Functions Documented:** Y | **Gaps:** Z ### Generated Docstrings | File | Function | Status | |------|----------|--------| ### Gaps Remaining | File | Missing | |------|---------| ``` ## Follow-Up After presenting results, offer: - "Want me to apply these docstrings to the files?" - "Should I audit the rest of the project?" - "Want a README section generated from this?"