generate-component-documentation
🎯Skillfrom longbridge/gpui-component
|Generates comprehensive markdown documentation for React/UI components by analyzing existing documentation patterns and component implementations.
Installation
npx skills add https://github.com/longbridge/gpui-component --skill generate-component-documentationSkill Details
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)
More from this repository10
Enforces consistent GPUI component design patterns by providing a comprehensive style guide for creating and reviewing Rust UI components.
Enables asynchronous operations and background tasks in GPUI, allowing seamless coordination between UI updates and concurrent computations.
Enables type-safe event handling, subscriptions, and observations for coordinating component interactions in GPUI applications.
Provides CSS-like layout and styling for Rust GPUI components using type-safe, chainable methods for flexbox, sizing, colors, and spacing.
Manages application state through safe, concurrent entities with read, update, and weak reference capabilities for reactive and async-friendly state handling in GPUI.
gpui-context skill from longbridge/gpui-component
Enables keyboard-driven focus management and navigation between focusable elements in GPUI user interfaces.
Defines and manages keyboard-driven actions and key bindings for declarative UI interactions in GPUI applications.
Enables comprehensive testing of GPUI applications with deterministic, single-threaded test execution for UI components and async operations.
Enables low-level, performance-critical custom UI element creation with precise control over layout, painting, and interaction phases in GPUI.