docs-revise

What problem does it solve?

It prevents documentation from drifting out of date by reconciling existing docs with the current codebase so readers don’t follow stale APIs or incorrect instructions.

Core Features & Use Cases

• Scope-aware revisions: Revise a single doc file by path (e.g., docs/api.md), a doc by component name (docs/<name>.md), or all files under docs/ when no argument is provided.
• Code-to-doc discrepancy detection: Compare what docs claim against what the source code actually does, including stale content, missing features, incorrect descriptions, broken references, and newly added components.
• Documentation lifecycle management: Update docs/README.md when needed, delete obsolete docs, and create missing docs for components that exist in code but lack documentation.
• Quality formatting: Reformat updated Markdown files using Prettier for consistent style.

Quick Start

Ask docs-revise to revise all documentation files in the docs/ directory for the current state of the repository.