generate-component-documentation
maintained by longbridge
star
9.9k
account_tree
438
verified_user
MIT License
name: generate-component-documentation description: Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.
Instructions
When generating documentation for a new component:
-
Follow existing patterns: Use the documentation styles found in the
docsfolder (examples:button.md,accordion.md, etc.) -
Reference implementations: Base the documentation on the same-named story implementation in
crates/story/src/stories -
API references: Use markdown
codeblocks with links to docs.rs for component API references when applicable
Examples
The generated documentation should include:
- Component description and purpose
- Props/API documentation
- Usage examples
- Visual examples (if applicable)
chat Comments (0)
Sign in to join the discussion and leave a comment.
Skill Details
GitHub Stars
9.9k
GitHub Forks
438
Created
Jan 2026
Last Updated
4个月前
tools
tools technical docs
Related Skills
Build your own?
Join 12,000+ developers contributing to the Claude ecosystem.
No comments yet. Be the first to share your thoughts!