generate-component-documentation

When generating documentation for a new component:

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "generate-component-documentation" with this command: npx skills add longbridge/gpui-component/longbridge-gpui-component-generate-component-documentation

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 Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

gpui-async

No summary provided by upstream source.

Repository SourceNeeds Review
General

gpui-layout-and-style

No summary provided by upstream source.

Repository SourceNeeds Review
General

gpui-context

No summary provided by upstream source.

Repository SourceNeeds Review