askill
generate-component-documentation

generate-component-documentationSafety 95Repository

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

28 stars
1.2k downloads
Updated 2/8/2026

Package Files

Loading files...
SKILL.md

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)

Install

Download ZIP
Requires askill CLI v1.0+

AI Quality Score

58/100Analyzed 2/22/2026

A moderate-quality skill document for generating component documentation. It provides general guidance and references existing patterns, but lacks specific actionable steps, trigger conditions, and detailed file paths. The nested path (.opencode/skills/) strongly suggests internal-only usage for this specific repo. While safe and reasonably clear, the skill feels more like a pattern reference than a comprehensive, reusable skill."

95
65
60
50
55

Metadata

Licenseunknown
Version-
Updated2/8/2026
Publisherzerx-lab

Tags

api