ui-docs-sync

Community

Detect drift between UI specs and repo docs.

AuthorThorStarlord
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: ui-docs-sync
Download link: https://github.com/ThorStarlord/interface-skills/archive/main.zip#ui-docs-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.