| name | generate-component-documentation |
| description | Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation. Use when this capability is needed. |
| metadata | {"author":"vicanso"} |
Instructions
When generating documentation for a new component:
- Follow existing patterns: Use the documentation styles found in the
docs folder (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
code blocks 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)
Source: vicanso/zedis — distributed by TomeVault.