docs

Automate documentation generation by running the docs tool to analyze source code and schemas, producing API references, READMEs, and architecture docs automatically. It uses audit, full, and default modes to refresh existing files or generate new ones.

Audit project documentation by running the tool in audit mode to identify gaps and outdated sections across your codebase. It performs gap analysis on API references, architecture docs, and setup guides to pinpoint missing or stale content.

Frontmatter-driven discovery is a mechanism that enforces metadata tagging in documentation files for automated tracking and updates. It allows the documentation automation tool to locate, parse, and refresh specific docs across a project systematically.

Yes, you can generate API reference documentation in bulk after a new release by running the docs tool. It performs bulk updates across API references, READMEs, and architecture docs to synchronize all materials with the latest changes.

Yes, the documentation automation tool integrates with a tech-writer agent for execution. This integration handles the generation and updating of API documentation, architecture guides, and setup references based on the audited codebase.

Use audit mode when you need to identify documentation gaps and outdated sections without immediately changing files. Use full mode when you want to perform a bulk documentation refresh and generate all missing API, architecture, and setup guides.