generate-component-documentation

Generate UI component documentation from established patterns and templates.

62|1|Updated Feb 5, 2026
One-click install
npx skills add https://github.com/zerx-lab/rmx --skill generate-component-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-component-documentation
Source: https://github.com/zerx-lab/rmx/tree/main/.opencode/skills/generate-component-documentation
Command: npx skills add https://github.com/zerx-lab/rmx --skill generate-component-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generating up-to-date, consistent documentation for new UI components is time-consuming when done manually. This Skill automates documentation creation by applying established patterns and templates.

Core Features & Use Cases

  • Pattern-based templates: Leverages documentation styles in the docs folder for consistency.
  • Story alignment: Mirrors the same-named story implementation in crates/story/src/stories to ensure code and docs stay in sync.
  • API reference integration: Incorporates API references (docs.rs) for prop and API details.

Quick Start

Follow the documented workflow to generate component documentation by using the existing templates in docs, aligning with the corresponding story implementation, and linking API references from docs.rs.

Frequently Asked Questions about generate-component-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate UI component documentation from existing patterns?

To auto-generate UI component documentation, this Skill applies established documentation templates from your docs folder to new components, ensuring structural consistency across your project. It leverages existing styles and story implementations to keep docs and code synchronized without manual writing.

What is the best way to keep component docs in sync with story implementations?

Keeping component docs in sync with story implementations is achieved by mirroring the same-named story implementation found in crates/story/src/stories. The Skill automatically aligns the generated documentation with these story files to prevent drift between code and written references.

How do I include API references from docs.rs in generated component documentation?

Including API references from docs.rs in generated component documentation is handled automatically by the Skill. It incorporates prop and API details from docs.rs into the final output, applying pattern-based styles to ensure the API reference integrates seamlessly with the rest of the docs.

Can I use pattern-based templates to document components across different folders?

Yes, you can use pattern-based templates to document components across the docs folder, story implementations, and API references. The Skill leverages documentation styles already established in these locations to generate consistent component documentation that matches your project's existing format.

Does this documentation generation approach require any external dependencies?

No external dependencies are required to use this documentation generation approach. The Skill operates independently by reading existing templates, story implementations in crates/story/src/stories, and API references from docs.rs to produce the final component documentation output.