generate-component-documentation

generate-component-documentation

热门

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

9.9KStar
426Fork
更新于 1/22/2026
SKILL.md
readonly只读
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)

You Might Also Like

Related Skills

update-docs

update-docs

137Kdev-docs

This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.

vercel avatarvercel
获取
docstring

docstring

97Kdev-docs

Write docstrings for PyTorch functions and methods following PyTorch conventions. Use when writing or updating docstrings in PyTorch code.

pytorch avatarpytorch
获取
docs-writer

docs-writer

94Kdev-docs

Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.

google-gemini avatargoogle-gemini
获取
write-concept

write-concept

66Kdev-docs

Write or review JavaScript concept documentation pages for the 33 JavaScript Concepts project, following strict structure and quality guidelines

leonardomso avatarleonardomso
获取
resource-curator

resource-curator

66Kdev-docs

Find, evaluate, and maintain high-quality external resources for JavaScript concept documentation, including auditing for broken and outdated links

leonardomso avatarleonardomso
获取
doc-coauthoring

doc-coauthoring

47Kdev-docs

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

anthropics avataranthropics
获取