docs-review

To audit API documentation against source code, validate endpoint coverage, enum values, and DTO field mappings to identify compliance gaps. This process checks .NET API and React/TypeScript services to maintain alignment between published docs and underlying code.

DocFX compliance validation verifies folder structure, TOC entries, and internal link resolution against documentation standards. It ensures published technical documentation is structurally sound, navigable, and free of broken internal references before team deployment.

Verify enum values and DTO fields by checking JSON property name mappings from attributes against source code definitions. This catches missing or outdated field examples and incorrect enum values that cause developer confusion and integration errors.

Yes, you can validate .NET API controller routes and auth policies by confirming every source code controller action has a corresponding documentation section. This endpoint coverage validation ensures matching routes and security configurations are accurately reflected.

The best way to catch missing DTO field examples is running a documentation audit that cross-references source code definitions with published docs. This generates a prioritized compliance report with severity-classified issues to guide necessary updates.

LENS service documentation falls out of sync with source code due to outdated endpoint definitions, incorrect enum values, and invalid DTO field examples introduced during development. Regular validation audits prevent these discrepancies from causing integration errors.