ui-docs-sync

Verify repository documentation and UI spec packages remain linked and consistent.

1|Updated May 6, 2026
One-click install
npx skills add https://github.com/ThorStarlord/interface-skills --skill ui-docs-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ui-docs-sync
Source: https://github.com/ThorStarlord/interface-skills/tree/main/skills/ui-docs-sync
Command: npx skills add https://github.com/ThorStarlord/interface-skills --skill ui-docs-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about ui-docs-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift between UI specs and repo docs?

To detect documentation drift between UI specs and repo docs, run an audit that discovers spec packages, verifies link coverage, and flags contradictions between spec claims and repository documentation without modifying files.

How do I check if repository documentation references all UI specification packages?

Checking if repository documentation references all UI specification packages involves scanning the codebase for spec packages and validating that relevant docs, product contracts, and route maps contain the necessary cross-artifact links.

What is UI spec and repo documentation consistency checking?

UI spec and repo documentation consistency checking is a read-only verification process that compares primary factual claims from spec packages against repository documentation to surface missing links, stale references, and invisible drift items.

Does UI documentation sync modify my GitHub repository files?

UI documentation sync does not modify your GitHub repository files; it operates as a read-only auditor that reports missing links, stale references, and unresolved blocker findings visible in the spec index.

When should I run a UI spec package and repo documentation audit?

You should run a UI spec package and repo documentation audit when creating or updating UI spec packages, changing documentation that describes UI behavior, onboarding agents, or recovering specs retroactively to ensure source-of-truth consistency.

Can I use this to onboard agents that rely on repository documentation?

Yes, you can use this to onboard agents that rely on repository documentation by verifying that agent instruction files and route maps consistently reference and match the UI specification packages defining each screen.