Does it require a specific folder structure?

Yes, it looks for files in predefined paths such as ./docs/content/docs/components and ./packages/rootage/components to perform its cross-reference checks.

How does it handle component props?

It parses Rootage YAML definitions for variants, sizes, and states, then compares them against the Props tables found in the MDX design guidelines.

Can it fix documentation issues automatically?

Currently, it focuses on identifying inconsistencies and generating a detailed report with specific recommendations, allowing developers to review changes before applying them.

What documentation layers does this skill support?

It is specifically optimized for the SEED Design System layers: Design Guidelines (MDX), Rootage Specs (YAML), and React Implementation Docs (MDX).

Why is this better than manual documentation auditing?

It automates the tedious task of cross-referencing technical YAML definitions with Markdown tables, ensuring 100% coverage and finding hidden mismatches in seconds.

Docs Consistency Checker

Name: Docs Consistency Checker
Author: workonthestreets

byworkonthestreets

0•

Aprendizaje y Documentación

Validates documentation consistency across design guidelines, technical specifications, and implementation docs for design systems.

The Docs Consistency Checker is a specialized tool designed to synchronize documentation across multiple layers of a design system, specifically targeting the SEED Design System architecture. It cross-references Design Guidelines, Rootage Technical Specs (YAML), and React Implementation Docs to ensure that component names, descriptions, and props remain identical across all platforms. By identifying orphaned files, missing property definitions, and naming mismatches, this skill prevents documentation drift and ensures that developers and designers are always working from a single, accurate source of truth.

Características Principales

01Automated validation of component props, variants, and sizes

02Detailed reporting with actionable recommendations for documentation fixes

030 GitHub stars

04Detection of orphaned documentation files and missing technical specs

05Component ID and naming synchronization across design and code layers

06Multi-layer cross-referencing between YAML specs and MDX documentation

Casos de Uso

01Cleaning up legacy documentation and identifying outdated component descriptions

02Pre-release auditing to ensure 100% documentation coverage and accuracy

03Validating new component documentation against technical Rootage specifications

Características Principales

01Automated validation of component props, variants, and sizes

02Detailed reporting with actionable recommendations for documentation fixes

030 GitHub stars

04Detection of orphaned documentation files and missing technical specs

05Component ID and naming synchronization across design and code layers

06Multi-layer cross-referencing between YAML specs and MDX documentation

Casos de Uso

01Cleaning up legacy documentation and identifying outdated component descriptions

02Pre-release auditing to ensure 100% documentation coverage and accuracy

03Validating new component documentation against technical Rootage specifications