xiaolai/docs-guardian-for-claude

docs-guardian-detection

Detect language and docs framework from markers like package.json and mkdocs.yml.

docs-guardian-fw-docusaurus

Docusaurus docs: detection, config parsing, doc root, code-to-doc mapping, template.

docs-guardian-fw-mkdocs

MkDocs docs: detection, config parsing, doc root, code-to-doc mapping, template.

docs-guardian-fw-plain-markdown

Plain Markdown docs: detection, doc root, layout, code-to-doc mapping, template.

docs-guardian-fw-sphinx

Sphinx docs: detection, config parsing, doc root, code-to-doc mapping, template.

docs-guardian-fw-vitepress

VitePress docs: detection, config parsing, doc root, code-to-doc mapping, template.

docs-guardian-lang-generic

Docs for languages with no dedicated skill: docstrings, API extraction, heuristics.

docs-guardian-lang-go

Go documentation: doc comment conventions, API doc extraction, Go-specific patterns.

docs-guardian-lang-python

Python documentation: docstring conventions, API doc extraction, Python patterns.

docs-guardian-lang-rust

Rust documentation: doc comment conventions, API doc extraction, Rust patterns.

docs-guardian-lang-typescript

TypeScript documentation: doc comment conventions, API doc extraction, TS patterns.

docs-guardian-mapping

Map source files to their docs: which docs cover which code, gaps, doc-to-code links.

docs-guardian-standards

Documentation quality standards: completeness, accuracy, freshness, project rules.

detection

Detect language and docs framework from markers like package.json and mkdocs.yml.

fw-docusaurus

Docusaurus docs: detection, config parsing, doc root, code-to-doc mapping, template.

fw-mkdocs

MkDocs docs: detection, config parsing, doc root, code-to-doc mapping, template.

fw-plain-markdown

Plain Markdown docs: detection, doc root, layout, code-to-doc mapping, template.

fw-sphinx

Sphinx docs: detection, config parsing, doc root, code-to-doc mapping, template.

fw-vitepress

VitePress docs: detection, config parsing, doc root, code-to-doc mapping, template.

lang-generic

Docs for languages with no dedicated skill: docstrings, API extraction, heuristics.

lang-go

Go documentation: doc comment conventions, API doc extraction, Go-specific patterns.

lang-python

Python documentation: docstring conventions, API doc extraction, Python patterns.

lang-rust

Rust documentation: doc comment conventions, API doc extraction, Rust patterns.

lang-typescript

TypeScript documentation: doc comment conventions, API doc extraction, TS patterns.

mapping

Map source files to their docs: which docs cover which code, gaps, doc-to-code links.

standards

Documentation quality standards: completeness, accuracy, freshness, project rules.

docs-guardian-accuracy-checker

Deep analysis of documentation accuracy — reads code and docs side by side to find mismatches in API signatures, parameters, return values, examples and behavioral claims, e.g. after a refactor changed signatures. Part of $docs-guardian-audit. Read-only. Not…

docs-guardian-audit

Full documentation audit — runs the staleness, accuracy, coverage and quality checks (in parallel subagents when available), then writes one report with a fixing plan to .claude/docs-guardian/audit-report.md.

docs-guardian-coverage-scanner

Find undocumented public APIs and compute documentation coverage per file and overall, ranked by severity. Runs standalone via $docs-guardian-coverage or inside $docs-guardian-audit. Read-only. Not for checking existing docs against code (use…

docs-guardian-coverage

Check documentation coverage — find undocumented public APIs and report per-file and overall coverage percentage.

docs-guardian-doc-writer

Generate or update documentation for undocumented or stale code — reads the source, understands the behavior, and writes docs in the project's documentation framework format. Run by $docs-guardian-generate after the user confirms which symbols to document.…

docs-guardian-generate

Generate missing documentation — find coverage gaps, confirm the symbols with the user, then write docs in the project's framework format. Optional argument: a file or directory to scope to.

docs-guardian-init

Initialize docs-guardian for this project — detect language and doc framework, propose code-to-doc mappings, set commit-hook strictness, and write .claude/docs-guardian/config.json. Optional arguments: language and framework.

docs-guardian-quality-rater

Rate documentation quality — empty sections, TODO markers, broken internal links, missing examples, inconsistent formatting — e.g. before publishing a docs site. Part of $docs-guardian-audit. Read-only. Not for accuracy or coverage (use…

docs-guardian-staleness-detector

Detect stale documentation by comparing git timestamps of source files and their mapped doc files — e.g. docs untouched since a major refactor. Runs scripts/docs-guardian/staleness-check.sh, then classifies each stale pair. Part of $docs-guardian-audit. Not…