generate-component-documentation
Original：🇺🇸 English
Translated
Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.
2installs
Added on
NPX Install
npx skill4agent add longbridge/gpui-component generate-component-documentationTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Instructions
When generating documentation for a new component:
- Follow existing patterns: Use the documentation styles found in the folder (examples:
docs,button.md, etc.)accordion.md - Reference implementations: Base the documentation on the same-named story implementation in
crates/story/src/stories - API references: Use markdown blocks with links to docs.rs for component API references when applicable
code
Examples
The generated documentation should include:
- Component description and purpose
- Props/API documentation
- Usage examples
- Visual examples (if applicable)