generate-component-documentation
CommunityAuto-generate component docs from patterns.
Authorzerx-lab
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Generating up-to-date, consistent documentation for new UI components is time-consuming when done manually. This Skill automates documentation creation by applying established patterns and templates.
Core Features & Use Cases
- Pattern-based templates: Leverages documentation styles in the docs folder for consistency.
- Story alignment: Mirrors the same-named story implementation in crates/story/src/stories to ensure code and docs stay in sync.
- API reference integration: Incorporates API references (docs.rs) for prop and API details.
Quick Start
Follow the documented workflow to generate component documentation by using the existing templates in docs, aligning with the corresponding story implementation, and linking API references from docs.rs.
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/zerx-lab/rmx/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 471,000+ vetted skills library on demand.