longbridge

generate-component-documentation

9,919
438
# Install this skill:
npx skills add longbridge/gpui-component --skill "generate-component-documentation"

Install specific skill from multi-skill repository

# Description

Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.

# SKILL.md


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:

  1. Follow existing patterns: Use the documentation styles found in the docs folder (examples: button.md, accordion.md, etc.)
  2. Reference implementations: Base the documentation on the same-named story implementation in crates/story/src/stories
  3. 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)

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.