doc-audit

Audits markdown documentation for frontmatter violations, broken links, count drift, and stale version references.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/ByronWilliamsCPA/plugin --skill doc-audit-byronwilliamscpa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-audit
Source: https://github.com/ByronWilliamsCPA/plugin/tree/main/plugins/wff-code/skills/doc-audit
Command: npx skills add https://github.com/ByronWilliamsCPA/plugin --skill doc-audit-byronwilliamscpa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Documentation drifts out of sync with code over time: frontmatter fields go missing, internal links break, claimed counts of agents or features become wrong, and version references go stale. This Skill automates a four-category health audit of markdown docs and produces a persistent report so issues are caught before they reach a PR. ## Core Features & Use Cases - Four-Category Static Scan: Checks frontmatter schema compliance, broken internal links, count claim drift, and stale version references against declared ranges. - Structured Reporting: Prints a terminal summary table with PASS/WARN/ERROR status per category and writes a persistent docs/audit-report.md with per-finding details including file and line numbers. - Docs Build Verification: Optionally runs mkdocs build --strict against main to catch docs build regressions that path-filtered CI jobs miss. - Use Case: Before merging a docs-touching PR, run the audit to confirm no broken links or stale Python version references exist, and fix the flagged findings at the source. ## Quick Start Ask the AI to run a documentation health audit on the docs directory and report any broken links, frontmatter violations, or stale version references. ## Quick Start Run the doc audit on your docs folder to get a summary table and a written report of all findings.

Frequently Asked Questions about doc-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check markdown docs for broken internal links?▼

Run the doc audit with a scope such as the docs directory, and it scans all markdown files for broken internal links. Findings are reported with file paths and line numbers in the terminal summary and in docs/audit-report.md.

How to audit documentation frontmatter for missing fields?▼

The audit validates frontmatter against the declared schema type and reports missing required fields such as owner. Each finding includes the file, line number, and schema type so violations can be fixed directly.

Can the doc audit run on a subdirectory instead of all docs?▼

Yes, the scope argument accepts any subdirectory, such as docs/superpowers/specs. When no scope is given, the audit defaults to scanning the entire docs directory.

Why does the docs build break on main without any docs PR?▼

Path-filtered CI jobs only run on docs-touching PRs, so a transitive dependency regression like a pygments or pymdown-extensions interaction can break mkdocs build --strict on main unnoticed. The audit runs the build against main as a supplementary check and surfaces failures as ERROR findings.

What are the limitations of static documentation audits?▼

Static scans catch frontmatter, link, count, and version issues but cannot detect a broken docs build caused by dependency regressions. That requires actually running mkdocs build --strict against current main as a separate check.