Docs Until Complete
This loop identifies and documents all missing features in a codebase to achieve full documentation coverage. It systematically audits the existing documentation, finds gaps, and fills them with appropriate documentation until the audit passes.
Goal
Document missing features
How to Run
Run this loop in your preferred coding environment to automatically detect undocumented features and add comprehensive documentation until full coverage is achieved.
- 01
Initialize the loop
Start the loop by providing the kickoff prompt in your coding agent interface (Cursor, Claude Code, Codex, etc.)
- 02
Let the loop run autonomously
The agent will execute workflow steps, running 'docs audit' checks and documenting missing features until the exit condition is met or max iterations are reached.
- 03
Review final documentation
Once exited, manually review the added documentation to ensure quality and accuracy before merging changes.
Workflow Steps
- 01
Run 'docs audit' to identify missing documentation
Execute the audit command to generate a list of undocumented features, functions, classes, or modules
- 02
Analyze audit results to prioritize missing docs
Review the audit output and categorize undocumented items by importance and impact
- 03
Document highest priority missing features
Create documentation (comments, docstrings, markdown files) for the most critical undocumented elements
- 04
Commit documentation changes
Save all added documentation with clear, descriptive commit messages
- 05
Re-run 'docs audit' to verify progress
Check if documentation coverage has improved and if the exit condition is met
- 06
Repeat until exit condition or max iterations
If exit condition not met, return to step 1 and continue documenting missing features
Kickoff Prompt
Start the "Docs Until Complete" loop. Goal: Document missing features Max iterations: 10 Between iterations run: docs audit Exit when: Documentation coverage complete Please audit this codebase for undocumented features and systematically document them until full coverage is achieved. Run 'docs audit' to identify gaps, then add appropriate documentation for each missing feature, prioritizing user-facing APIs and public interfaces. Continue iterating until the documentation coverage is complete or you've reached 10 iterations. Self-pace this loop. After each iteration, run `docs audit` and evaluate the output, and only continue if the exit condition is not met (Documentation coverage complete). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.
Guardrails
hardcoded- ·Focus only on features without existing documentation
- ·Follow the project's existing documentation style guide
- ·Avoid documenting experimental or commented-out code
- ·Prioritize user-facing APIs and public interfaces
- ·Verify code changes pass 'docs audit' before proceeding
Flow Diagram
Related loops — Docs
Docs
Changelog Generator
Automatically generates and maintains a project's CHANGELOG.md file by analyzing code changes, commits, or version control history to produce structured release notes.
Docs
Example Coverage Builder
Automatically identifies areas in your codebase lacking usage examples and iteratively adds them to improve documentation coverage. The agent focuses on generating practical, copy-paste-friendly examples for functions, methods, and components that currently lack adequate documentation.
Docs
API Docs Sync
Automatically synchronizes API documentation with the codebase to ensure no drift occurs between implementation and documented interfaces. This loop detects discrepancies, generates necessary updates, and applies them while respecting guardrails to maintain consistency and quality.