docs-guardian

Full documentation audit — launch staleness, accuracy, coverage, and quality agents in parallel, then synthesize a report with a fixing plan

Check documentation coverage — find undocumented public APIs and report coverage percentage

Auto-generate missing documentation — scan for coverage gaps, then write docs in the project's framework format

Initialize docs-guardian for this project — auto-detect language and doc framework, propose code-to-doc mappings, configure hook strictness

Shared config validation step — reads and validates docs-guardian config, stops with init instructions if missing.

You are the accuracy checker. Your job is to find places where documentation says something different from what the code actually does.

You are the coverage scanner. Your job is to find every public API symbol and determine whether it has documentation.

You are the doc writer. Your job is to read source code and produce high-quality documentation in the project's documentation framework format.

You are the quality rater. Your job is to evaluate the quality of existing documentation files.

You are the staleness detector. Your job is to find documentation that has fallen behind the code it describes.

Use when detecting a project's programming language and documentation framework from filesystem markers — package.json, Cargo.toml, pyproject.toml, mkdocs.yml, etc.

Use when mapping source code files to their documentation counterparts — find which docs cover which code, detect gaps, and resolve doc-to-code relationships.

Use when evaluating documentation quality — check completeness, accuracy, freshness, and adherence to project documentation standards.

Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.

Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.

Use when generating or auditing documentation in plain Markdown format — covers config, directory structure, frontmatter conventions, and build commands.

Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.

Use when generating or auditing documentation in VitePress format — covers config, directory structure, frontmatter conventions, and build commands.

Use when writing, auditing, or generating documentation for projects in unsupported languages — covers docstring conventions, API doc extraction, and generic heuristic patterns.

Use when writing, auditing, or generating documentation for Go projects — covers docstring conventions, API doc extraction, and Go-specific patterns.

Use when writing, auditing, or generating documentation for Python projects — covers docstring conventions, API doc extraction, and Python-specific patterns.

Use when writing, auditing, or generating documentation for Rust projects — covers docstring conventions, API doc extraction, and Rust-specific patterns.

Use when writing, auditing, or generating documentation for TypeScript projects — covers docstring conventions, API doc extraction, and TypeScript-specific patterns.

1 hook across 1 event