vibe-review-docs

To audit markdown documentation, review entry files like CLAUDE.md and docs/ directories to identify conceptual errors, outdated instructions, and missing changelog updates. This process flags misalignments between project docs and current architecture.

A documentation review for a docs-only PR evaluates changed markdown files for conceptual alignment and clarity rather than code correctness. It checks for outdated instructions and missing governance updates to ensure docs reflect current workflows.

To check if a changelog is missing required updates, inspect CHANGELOG.md alongside repository diffs or PR file lists. This comparison reveals incomplete entries and highlights governance updates needed to align documentation with code changes.

Yes, you can review project entry files like SOUL.md and STRUCTURE.md for terminology errors. The documentation audit validates these files against current architecture to identify conceptual drift and correct incorrect terminology.

Yes, you need access to repository diffs or PR file lists to perform a markdown documentation audit. Parsing these diffs is required to compare markdown and CLI references against actual code changes and produce a prioritized review report.

The best way to generate a prioritized doc review report is to parse markdown files and CLI references from changed branches, categorize findings into required edits and suggestions, and append a handoff milestone to record review completion.