Docs Consistency Checker

•
81
•

Ensures structural and content alignment across design guidelines, technical specifications, and framework-specific documentation layers.

The Docs Consistency Checker is a specialized auditing tool designed for the SEED Design System that automates the verification of content across three distinct layers: Design Guidelines, Rootage Component Specs (YAML), and React Implementation docs. It meticulously cross-references component naming, descriptions, props, and metadata to identify mismatches or missing documentation. This skill is essential for maintaining a single source of truth, ensuring that what is defined in the technical spec is accurately reflected in both design and development guides.

主要功能

01Metadata synchronization checks for component IDs and naming conventions
02Automatic identification of orphaned documentation or missing files
03Deep prop and variant verification against technical schemas
0481 GitHub stars
05Multi-layer cross-validation between MDX docs and YAML specifications
06Actionable summary report generation with critical and warning flags

使用场景

01Syncing React API documentation with the core Rootage component specifications
02Performing comprehensive documentation audits before major design system releases
03Validating new component documentation for consistency before merging pull requests