What problem does it solve?
It prevents misleading repository documentation by verifying that repository-level docs and routing/product contracts consistently reference and match the UI specification packages that define each screen and component.
Core Features & Use Cases
- Cross-artifact linking: Ensures every discovered UI spec package is referenced by relevant repository docs (READMEs, product contracts, route maps, and agent instruction files).
- Source-of-truth consistency checks: Flags contradictions between the primary factual claims in a spec package (user, action, auth/constraints, modes) and what repo documentation claims.
- Open drift visibility: Helps surface unresolved blocker/major lint or redline findings by checking whether they are visible in the spec index or referenced in repository-level docs.
Quick Start
Run ui-docs-sync to audit that your repository docs and UI spec packages agree, especially after updating product contracts or creating a new UI spec package.