generate-component-documentation | Skill Performance & Reviews | TopRankSkills

TopRank Skills

Home / Skills / tools / generate-component-documentati...

generate-component-documentation

maintained by longbridge

star 9.9k account_tree 438 verified_user MIT License
bolt View GitHub

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)

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!

Skill Details

GitHub Stars 9.9k
GitHub Forks 438
Created Jan 2026
Last Updated 4个月前
tools tools technical docs

Related Skills

gh-docs
chevron_right
writing-plans
chevron_right
makepad-reference
chevron_right
mintlify-docs
chevron_right
gemini-cli
chevron_right

Build your own?

Join 12,000+ developers contributing to the Claude ecosystem.