review-doc-consistency

To find outdated README files, scan your repository to compare markdown documentation against actual code and configurations. This process surfaces inconsistencies by outputting a concise list of issues with cited evidence to support fixes.

You can verify OpenAPI documentation by scanning contract files and comparing them against code implementation. This surfaces mismatched schemas and endpoints, ensuring your docs accurately reflect the current API with cited evidence.

Documentation drift occurs when README files diverge from actual implementation. You detect it by scanning your repository root to compare markdown and contract files against code, generating a report of inconsistencies to prevent user confusion.

Yes, documentation consistency verification works with TypeScript types and configurations across the repository. It applies these contract files alongside markdown docs to surface outdated information with cited code locations.

The best way to fix mismatched README files is to run a scan against your repository root to generate a report of documentation versus code inconsistencies. This provides evidence-based findings to support efficient corrections.

You need to check documentation consistency when updating an API or modifying code configurations to verify that docs reflect the current endpoints and schemas. This prevents user confusion caused by documentation drifting from implementation.