review-doc-consistency

To check documentation consistency, you can validate your README and docs directory against the live codebase. This process identifies discrepancies in features, APIs, and configurations, treating the code as the source of truth to detect outdated content.

Verifying API documentation accuracy after refactoring involves scanning your docs to ensure endpoints, parameters, and return values match the updated code. This validation flags sections that contradict the implementation, ensuring users have accurate information.

Detecting outdated content in technical documentation is best done by cross-referencing docs with the live codebase. This consistency check identifies descriptions and configuration details that no longer reflect the current state of the code.

Yes, you can validate contract files and configuration settings against your source code. The validation process scans these files to identify discrepancies in security settings and configurations, prioritizing the code implementation as the source of truth.

Documentation inconsistencies are prioritized and reported using detailed reports with severity levels for each issue found. This validation process identifies discrepancies across README, docs directory, and contract files to highlight critical mismatches.

Documentation validation works for security settings and configuration mismatches by scanning contract files and docs. It identifies discrepancies between documented configurations and the live code, generating detailed reports with severity levels for each inconsistency.