doc-update

To detect documentation drift after refactoring, you need to compare exported APIs, routes, and dependencies against current specs. This workflow identifies where recent code changes require matching documentation updates and outputs a structured report listing remaining divergences.

Spec-first synchronization treats documentation as the source of truth rather than the code itself. It updates the specification to match codebase changes, ensuring the revised spec remains internally consistent and preventing AI-generated code from relying on stale documentation.

Validating internal links and code examples involves verifying that referenced paths exist, internal links resolve correctly, and code examples actually compile and run. This workflow runs documentation validation to check link and path correctness rather than treating examples as static text.

Yes, you can generate or refresh module index information to create codemaps. This accelerates future navigation and reduces re-scanning effort during development sessions by keeping the module index up to date with the current architecture.

The best way to update API documentation after route modifications is to run a hardening workflow that detects documentation-to-code drift. It updates affected spec documents, verifies version claims are current, and produces a documentation truth report to restore correctness.

You should run a documentation update workflow after refactors, API surface changes, route modifications, or dependency additions. It enforces spec-first synchronization during hardening or doc/code review contexts to prevent future AI-generated code from relying on stale specifications.