generate-component-documentation
OfficialCreate consistent component docs.
Authorlongbridge
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Writing documentation for every new component is time-consuming and prone to inconsistency. This skill automates and standardizes component documentation, ensuring all components follow a shared structure and style.
Core Features & Use Cases
- Template-driven documentation generation that mirrors existing docs styles and layout.
- References the same-named story implementations to align API and usage examples.
- Produces ready-to-publish Markdown documents with a consistent structure for onboarding, design reviews, and contributor guides.
Quick Start
Run the generate-component-documentation tool on the new component to produce a standardized Markdown doc in the docs folder.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: generate-component-documentation Download link: https://github.com/longbridge/gpui-component/archive/main.zip#generate-component-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.