How are the results presented?

It provides a comprehensive report with status icons (Critical, Warning, Missing) and detailed recommendations for exactly which files need alignment.

Which documentation layers does this skill support?

It is optimized for the SEED Design System architecture, covering Design Guidelines (MDX), Rootage Component Specs (YAML), and React Implementation Docs (MDX).

Does it require specific tools to run?

The skill utilizes standard file system tools like Read, Grep, and Glob to navigate and analyze your documentation structure.

Can it detect missing properties in the documentation?

Yes, it extracts variant and size definitions from the Rootage YAML files and compares them against the Props tables in your MDX files to find undocumented features.

Docs Consistency Checker

Name: Docs Consistency Checker
Author: Microck

byMicrock

•

콘텐츠 관리

Validates and synchronizes component documentation across design guidelines, technical specs, and React implementation layers.

소개

The Docs Consistency Checker is a specialized utility designed for the SEED Design System to ensure documentation remains accurate across multiple technical and design layers. It automatically cross-references Rootage YAML specifications with MDX documentation in both design and React implementation directories, identifying mismatches in component naming, descriptions, and props. This tool is essential for maintaining a single source of truth within complex design systems, helping teams catch documentation gaps, orphaned files, or outdated specifications before production releases.

주요 기능

Identification of orphaned or missing documentation files
Generation of detailed audit reports with actionable fix recommendations
Automated cross-layer validation between YAML specs and MDX docs
81 GitHub stars
Deep props and variants comparison against technical definitions
Validation of component IDs and metadata consistency

사용 사례

Periodic documentation maintenance to sync React implementation with design guidelines
Validating new component documentation sets before merging into the main repository
Pre-release audits to ensure all component documentation is complete and accurate

소개

주요 기능

Identification of orphaned or missing documentation files
Generation of detailed audit reports with actionable fix recommendations
Automated cross-layer validation between YAML specs and MDX docs
81 GitHub stars
Deep props and variants comparison against technical definitions
Validation of component IDs and metadata consistency

사용 사례

Periodic documentation maintenance to sync React implementation with design guidelines
Validating new component documentation sets before merging into the main repository
Pre-release audits to ensure all component documentation is complete and accurate