component-docs

Generate or update UI component documentation with props tables and Storybook stories.

21|2|Updated Nov 5, 2023
One-click install
npx skills add https://github.com/sgcarstrends/sgcarstrends --skill component-docs-sgcarstrends
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: component-docs
Source: https://github.com/sgcarstrends/sgcarstrends/tree/main/.claude/skills/component-docs
Command: npx skills add https://github.com/sgcarstrends/sgcarstrends --skill component-docs-sgcarstrends

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates writing and updating component docs with props, examples, and Storybook stories.

Core Features & Use Cases

  • Props tables and usage examples.
  • Storybook integration notes.
  • Documentation templates for consistency.

Quick Start

Generate documentation for a new Button component with props and a usage example.

Frequently Asked Questions about component-docs

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

FAQPage Schema
How do I document UI components with props tables and usage examples?

Component documentation generation automates creating props tables, usage examples, and JSDoc comments for UI components. The Skill produces structured docs that include code blocks, accessible formatting, and Storybook integration notes within your package's README and docs sections.

Can I use component documentation with Storybook?

Yes. Component documentation integrates with Storybook by generating story references and documentation templates that link to your Storybook instances, ensuring consistency between component stories and written documentation.

What documentation template structure does this Skill apply?

The Skill enforces consistent documentation templates across components, including JSDoc comments, props tables, usage examples, and accessible structure. Templates apply to new components and improve existing docs within packages/ui/.

How do I automate updates to existing component documentation?

The Skill updates existing component docs by regenerating props tables, adding new usage examples, and refreshing Storybook story references while maintaining your template structure and documentation standards.

What should I prepare before documenting a new component?

Have your component code ready with prop definitions and JSDoc comments. The Skill generates documentation from these inputs, creating props tables, examples, and Storybook integration notes that follow the template structure.

Does component documentation work for components outside the packages/ui/ folder?

The Skill focuses on documenting UI components within packages/ui/. Its template and documentation structure are optimized for that context, though the documentation approach applies to component-based architectures generally.