design-system-docu-skills

Document Sprout design-system components using a standardized 5-tab VitePress pattern.

Updated Mar 2, 2026
One-click install
npx skills add https://github.com/micserr/toge-design-system --skill design-system-docu-skills
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-system-docu-skills
Source: https://github.com/micserr/toge-design-system/tree/main/skill/design-system-docu-skills
Command: npx skills add https://github.com/micserr/toge-design-system --skill design-system-docu-skills

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a structured approach to creating and maintaining component documentation for the Sprout Design System using a tabbed VitePress pattern, ensuring consistency across components and locales.

Core Features & Use Cases

  • Standardized multi-tab documentation (Live Example, Code Docu, Guidelines, UI Specs, Accessibility)
  • Tab navigation with a reusable ComponentTabBar and live <PropsPlayground> demos
  • Locale support (EN and TH) with rewrites and sidebar configuration templates
  • Ready-made references/templates in references/ to guide documentation additions
  • Scaffolding for new components via add-component-tabs workflow

Quick Start

Define the skill by adding a SKILL.md with name and description and populate references/ with the tab standard guidelines to start using it.

Frequently Asked Questions about design-system-docu-skills

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

FAQPage Schema
How do I structure VitePress component documentation with multiple tabs?

VitePress component documentation can be structured using a standardized 5-tab pattern covering Live Example, Code Docu, Guidelines, UI Specs, and Accessibility. This approach enforces consistent frontmatter naming and uses a reusable ComponentTabBar for navigation.

Can I maintain design-system docs in both English and Thai locales?

Yes, design-system documentation can support EN and TH locales using VitePress. This is achieved by applying locale-specific rewrites and sidebar configuration templates to ensure content consistency across different languages.

What's the best way to scaffold new component docs in a design system?

Scaffolding new component docs is best handled through an add-component-tabs workflow. This populates the documentation with ready-made reference templates and live <PropsPlayground> demos, ensuring every new component follows the standard guidelines.

Does VitePress support live interactive code demos for component docs?

VitePress supports live interactive code demos using the <PropsPlayground> component. This allows you to embed functional examples directly within the Live Example tab of your multi-tabbed component documentation structure.

How do I enforce consistent frontmatter naming across component documentation?

Consistent frontmatter naming across component documentation is enforced by applying a standardized documentation skill. It utilizes predefined reference templates sourced from SKILL.md to govern the metadata structure for every component.

Why use a standardized tab structure for design-system component docs?

A standardized tab structure for design-system component docs ensures uniformity across components and locales. It separates concerns into Live Example, Code Docu, Guidelines, UI Specs, and Accessibility, making the documentation predictable and easier to navigate.