docs-review

What problem does it solve?

Reviews existing documentation to ensure accuracy against the codebase, appropriateness for the target audience, and proper structural organization, reducing release risks and post-release rewrites.

Core Features & Use Cases

• Systematically inventories pages and sections to verify alignment with code and APIs.
• Checks audience suitability, terminology, and structure using the provided review checklist.
• Generates a prioritized remediation plan with suggested edits and a final validation pass.
• Use Case: A documentation site for Astro Starlight requires a health check before a major release to ensure all pages reflect current code behavior.

Quick Start

Provide the docs URL or repository path and run the docs-review workflow to generate a structured review report.