Skip to content
Back to skills

Generate Component Documentation

ASecurity

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

  • 8 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added May 29, 2026
documentationapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned May 29, 2026

npx -y skills add zjunlp/Skills --skill generate-component-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Generate Component Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Generate Component Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/zjunlp-generate-component-documentation/badge)](https://www.skillsdirectory.com/skills/zjunlp-generate-component-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
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)

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…