Stats
Actions
Available In
Tags
Plugin
docs-guardian
Enforce documentation quality and freshness across projects by detecting stale docs, measuring coverage of public APIs, verifying accuracy against source code, and auto-generating missing documentation for Python, TypeScript, Go, and Rust in MkDocs, VitePress, Docusaurus, Sphinx, or plain Markdown. A full audit command produces a report with scores, findings, and a fixing plan.
What's Inside
Slash Commands5
audit
/audit
Full documentation audit — launch staleness, accuracy, coverage, and quality agents in parallel, then synthesize a report with a fixing plan
coverage
/coverage
Check documentation coverage — find undocumented public APIs and report coverage percentage
generate
/generate
Auto-generate missing documentation — scan for coverage gaps, then write docs in the project's framework format
init
/init
Initialize docs-guardian for this project — auto-detect language and doc framework, propose code-to-doc mappings, configure hook strictness
validate-config
/validate-config
Shared config validation step — reads and validates docs-guardian config, stops with init instructions if missing.
Agents5
Your mission
/accuracy-checker
You are the accuracy checker. Your job is to find places where documentation says something different from what the code actually does.
Your mission
/coverage-scanner
You are the coverage scanner. Your job is to find every public API symbol and determine whether it has documentation.
Your mission
/doc-writer
You are the doc writer. Your job is to read source code and produce high-quality documentation in the project's documentation framework format.
Your mission
/quality-rater
You are the quality rater. Your job is to evaluate the quality of existing documentation files.
Your mission
/staleness-detector
You are the staleness detector. Your job is to find documentation that has fallen behind the code it describes.
Skills13
detection
/detection
Use when detecting a project's programming language and documentation framework from filesystem markers — package.json, Cargo.toml, pyproject.toml, mkdocs.yml, etc.
mapping
/mapping
Use when mapping source code files to their documentation counterparts — find which docs cover which code, detect gaps, and resolve doc-to-code relationships.
standards
/standards
Use when evaluating documentation quality — check completeness, accuracy, freshness, and adherence to project documentation standards.
fw-docusaurus
/fw-docusaurus
Use when generating or auditing documentation in Docusaurus format — covers config, directory structure, frontmatter conventions, and build commands.
fw-mkdocs
/fw-mkdocs
Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.
Stats
Version0.1.8
LanguageShell
Stars6
MaintenanceExcellent
LicenseISC
Last Commit
Added
Available In
Safety Signals
Caution
Executes bash commands
Hook triggers when Bash tool is used
Uses power tools
Uses Bash, Write, or Edit tools
Has parse errors
