UI Component Documentation Writer

Generate MDX documentation and live TSX examples for Medusa UI components.

35.7k|5.0k|Updated Jan 18, 2020
One-click install
npx skills add https://github.com/medusajs/medusa --skill ui-component-documentation-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: UI Component Documentation Writer
Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/ui-component-doc
Command: npx skills add https://github.com/medusajs/medusa --skill ui-component-documentation-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive documentation for UI components within the Medusa design system, ensuring consistency and clarity for developers.

Core Features & Use Cases

  • MDX Documentation Generation: Creates detailed documentation pages including usage examples and API references.
  • Live Example Creation: Generates runnable TSX examples for various component states and variants.
  • Example Registry Updates: Automatically registers new examples for discoverability.
  • Use Case: When a new Avatar component is developed, this Skill can generate its page.mdx documentation, create examples for default, group, and status variants, and update the examples.mjs registry.

Quick Start

Use the UI Component Documentation Writer skill to document the 'Avatar' component, including its default, group, and status variants.

Frequently Asked Questions about UI Component Documentation Writer

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

FAQPage Schema
How do I generate MDX documentation for React UI components?

To generate MDX documentation for React UI components, you can use an automated approach that parses TypeScript types and source code to populate usage instructions, API references, and interactive examples directly into MDX pages.

What is the best way to document Medusa UI component variants?

The best way to document Medusa UI component variants is to parse the source code and TypeScript types to automatically generate detailed MDX pages alongside runnable TSX examples for different component states.

How do I create live TSX examples for a TypeScript UI component library?

Creating live TSX examples for a TypeScript UI component library involves parsing the component's source code and types to generate runnable examples for various states, then updating an example registry for discoverability.

Can I automatically register new UI component examples in Medusa?

Yes, you can automatically register new UI component examples in Medusa by updating the example registry during the documentation generation process, ensuring the new TSX examples are discoverable.

Does generating UI component documentation require manual TypeScript type parsing?

No, generating UI component documentation does not require manual TypeScript type parsing because the process automatically extracts TypeScript types and source code to populate API references and usage instructions.