document-generate

You can generate complete project documentation automatically by running a workflow that analyzes your repository context and produces structured outputs. This process creates tutorials, how-to guides, references, and explanations without manual authoring.

The Diataxis framework is a documentation structure that divides content into four types: tutorials, how-to guides, reference material, and explanations. It ensures comprehensive coverage of audience needs by separating learning-oriented content from practical steps and technical references.

To create tutorials and reference docs from existing code, run an automated generation workflow on your target feature or module. The system aligns output with your repository's context and assets to produce ready-to-publish documentation.

Yes, documentation generation can be invoked standalone or integrated directly into a document-release workflow. This integration keeps your docs synchronized with code changes during releases without requiring separate manual updates.

Generating docs from a repository with prompt injection risks is handled by enforcing safety gates. The workflow tests prompts for injection risks, prevents data exfiltration, and uses plan-mode safety routing to preserve security while generating output.

Automated documentation generation relies on existing repository context and assets to ensure correctness, meaning sparse or poorly structured codebases may produce limited output. It operates within safety gates that restrict unsafe prompt execution and prevent data exfiltration.