docs-guardian

Plugin docs-guardian in xiaolai/codex-marketplace. Commands read from the repo's manifest — 1 month ago.

Skills (35)

• 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 for coverage (use $docs-guardian-coverage

• 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-accuracy-checker) or writing docs (use $do

• docs-guardian-coverage

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

• docs-guardian-detection

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

• 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. Not for auditing docs without changing them

• 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-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-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-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-accuracy-checker or $docs-guardian-coverage-scan

• 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 for checking whether doc content matches t

• 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.

Slash commands (5)

• /docs-guardian:audit

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

• /docs-guardian:coverage

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

• /docs-guardian:generate

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

• /docs-guardian:init

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

• /docs-guardian:shared:validate-config

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

Subagents (5)

• accuracy-checker

  Use this agent for deep analysis of documentation accuracy — reads both code and docs to find mismatches in API signatures, parameter descriptions, return values, examples, and behavioral claims, including after a migration or refactor that changed function signatures. Not for measuring how much of

• coverage-scanner

  Use this agent to find undocumented public APIs and calculate documentation coverage percentage, or to list which public functions lack documentation, ranked by severity. Works standalone via /coverage or as part of a full audit. Not for checking whether existing docs match the code (use accuracy-ch

• doc-writer

  Use this agent to generate or update documentation for undocumented or stale code, including refreshing a module's docs after it was rewritten. Reads source code, understands behavior, and writes docs in the project's documentation framework format. Not for auditing docs without changing them; the o

• quality-rater

  Use this agent to rate documentation quality — checks for empty sections, TODO markers, broken links, missing examples, inconsistent formatting, and other quality issues, for example before publishing a docs site. Not for accuracy or coverage problems (use accuracy-checker or coverage-scanner), and

• staleness-detector

  Use this agent to detect stale documentation by comparing git timestamps between source files and their corresponding doc files, for example to flag docs untouched since a major refactor before a release. Runs staleness-check.sh for mechanical git work, then interprets the results. Not for checking

Hooks (1)

• PreToolUse

  node "${CLAUDE_PLUGIN_ROOT}/scripts/docs-guardian/commit-guard.js"

Similar plugins