ReddRadar
Agent skill
generate-component-documentation
Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.
Install this agent skill to your Project
npx add-skill https://github.com/longbridge/gpui-component/tree/main/.claude/skills/generate-component-documentation
SKILL.md
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)
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
longbridge/gpui-component
gpui-test
Writing tests for GPUI applications. Use when testing components, async operations, or UI behavior.
longbridge/gpui-component
gpui-async
Async operations and background tasks in GPUI. Use when working with async, spawn, background tasks, or concurrent operations. Essential for handling async I/O, long-running computations, and coordinating between foreground UI updates and background work.
longbridge/gpui-component
gpui-action
Action definitions and keyboard shortcuts in GPUI. Use when implementing actions, keyboard shortcuts, or key bindings.
longbridge/gpui-component
github-pull-request-description
Write a description to description GitHub Pull Request.
longbridge/gpui-component
gpui-layout-and-style
Layout and styling in GPUI. Use when styling components, layout systems, or CSS-like properties.
longbridge/gpui-component
gpui-context
Context management in GPUI including App, Window, and AsyncApp. Use when working with contexts, entity updates, or window operations. Different context types provide different capabilities for UI rendering, entity management, and async operations.
Didn't find tool you were looking for?