Search

PythonReactSEOPDF
GitHub Skill

generate-component-documentation

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

longbridge☆ 9,913 Repository stars438 Repository forks

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

View source ↗Guides

Skill instructions

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)

Examples

Read the usage examples in the source repository.

View source ↗

Source history

Indexed on
2026-01-20
Index updated
2026-01-28
Branch
main

Index and sync dates describe this directory. View the source repository for code history.

GitHub ↗

chat Comments (0)

chat_bubble_outline

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