Connect

Component Guidelines Documentation

daangnbydaangn
•
799
•
Learning & Documentation

Generates standardized component guideline documentation for the SEED Design System by extracting technical specifications from Rootage YAML files.

Streamline the creation and maintenance of high-quality design system documentation with this specialized tool designed for the SEED Design System. By parsing Rootage YAML specifications, it automatically generates comprehensive MDX files featuring property tables, component anatomy, and detailed usage guidelines. Whether creating documentation for simple UI elements or complex interactive components, it ensures consistency in structure, image naming conventions, and technical accuracy while providing specialized support for Korean language documentation and automated image optimization workflows.

Key Features

01799 GitHub stars
02Enforces strict image naming and path conventions for design assets
03Generates standardized MDX documentation with consistent layouts for anatomy and guidelines
04Provides Korean language templates for professional tone and voice
05Includes built-in support for Do/Don't grids and platform status tables
06Extracts component props and specs automatically from Rootage YAML files

Use Cases

01Creating initial guideline documentation for new design system components
02Updating existing documentation to reflect changes in component specifications
03Migrating component guides from V2 to V3 design system versions