docs-compliance-codebase

What problem does it solve?

This Skill eliminates uncertainty about documentation accuracy by auditing Markdown guides against real code paths, naming, and platform expectations so teams avoid misleading or outdated content.

Core Features & Use Cases

• Scope clarification: Guides users to define the docs targets, audience, and coverage before beginning work.
• Automated scanning and linting: Executes the scan_codebase.py mapping plus lint_markdown.py to identify structural faults and missing links.
• Compliance review: Compares documentation to rules in references/compliance-rules.md, ensuring terminology, API, and platform claims match the actual repo state.
• Use Case: When releasing a new feature, use this Skill to confirm the public README, API guides, and integration notes all faithfully describe the current backend flags, routes, and dependencies.

Quick Start

Describe the documentation scope, run the scan and lint scripts, and summarize the compliance gaps with the rubric before requesting revisions.