generate-component-documentation
Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
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)
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-28
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!