# Generate Component Documentation

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

- Skill: `mahabdalla/generate-component-documentation` (Agent Skill)
- Install (CLI): `npx skillmds@latest add mahabdalla/generate-component-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/mahabdalla/generate-component-documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Web & Frontend
- Author: mahabdalla (https://skillmd.com/u/mahabdalla)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/mahabdalla/generate-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)

---
> Converted and distributed by [TomeVault](https://tomevault.io) | [Claim this content](https://tomevault.io/claim/longbridge/gpui-component)