component-guidelines-docs

Generate Korean-language SEED component guideline docs from Rootage YAML.

1.0k|75|Updated Mar 11, 2021
One-click install
npx skills add https://github.com/daangn/seed-design --skill component-guidelines-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: component-guidelines-docs
Source: https://github.com/daangn/seed-design/tree/main/.claude/skills/component-guidelines-docs
Command: npx skills add https://github.com/daangn/seed-design --skill component-guidelines-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill generates high-quality component guideline documentation that aligns with Rootage YAML specs and SEED design patterns.

Core Features & Use Cases

  • Rootage-Driven Props: Automatically extract props and slots from YAML to document APIs consistently.
  • Guidance & Do's/Dont's: Produce structured guidelines with practical examples and images.
  • Standardized Structure: Output MDX-ready docs that match existing design guidelines.

Quick Start

Provide a component ID that exists in Rootage (e.g., action-button) to generate or update its guidelines in docs/content/docs/components/{id}.mdx.

Frequently Asked Questions about component-guidelines-docs

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

FAQPage Schema
How do I generate component guideline documentation from Rootage YAML?

Component guideline documentation is generated by providing a component ID that exists in Rootage YAML. The Skill automatically extracts props and slots from `/packages/rootage/components/{component-id}.yaml`, then produces standardized MDX documentation with anatomy, guidelines, do's/don'ts, and component references in `docs/content/docs/components/{id}.mdx`.

What should component guidelines include for SEED Design System?

SEED component guidelines should include extracted API props from Rootage YAML, structured anatomy sections, practical usage guidelines with do's and don'ts, image references, component comparisons, and V2-to-V3 migration guides where applicable. Output is delivered in Korean-language MDX format matching existing design patterns.

Can I update existing component documentation with this Skill?

Yes, this Skill handles both creating new component documents and updating existing guidelines. It re-extracts current props from Rootage YAML and regenerates standardized sections, ensuring documentation stays aligned with component specifications and design system consistency.

What's the input format for generating component guidelines?

The primary input is a component ID referencing an existing Rootage YAML file at `/packages/rootage/components/{component-id}.yaml`. The Skill parses this YAML to extract props, slots, and specifications, then uses that structured data to build comprehensive guideline documentation.

Does this Skill support migration documentation between component versions?

Yes, the Skill can generate V2-to-V3 migration guides as part of component guideline documentation. It documents API changes and guidance to help users transition between versions while maintaining consistency with SEED Design System standards.

Why use YAML-driven documentation over manual writing?

YAML-driven documentation ensures consistency across all SEED components by automatically extracting the source of truth—props, slots, and specifications—from Rootage files. This eliminates manual errors, keeps docs synchronized with actual component APIs, and produces standardized MDX output.