component-docs-writer

Generate MDX component documentation with demos and anatomy diagrams for Marigold Design System.

142|14|Updated Jan 14, 2020
One-click install
npx skills add https://github.com/marigold-ui/marigold --skill component-docs-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: component-docs-writer
Source: https://github.com/marigold-ui/marigold/tree/main/.claude/skills/component-docs-writer
Command: npx skills add https://github.com/marigold-ui/marigold --skill component-docs-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the creation of high-quality, consistent documentation for Marigold Design System components, ensuring clarity, accuracy, and adherence to best practices.

Core Features & Use Cases

  • MDX Documentation Generation: Writes comprehensive MDX files for components, patterns, and foundations.
  • Interactive Demo Creation: Generates .demo.tsx files to showcase component functionality.
  • Anatomy Diagram Guidance: Provides instructions and patterns for creating clear SVG anatomy diagrams.
  • Use Case: When a new Avatar component is developed, this Skill can generate its initial MDX structure, anatomy diagram placeholders, and basic demo files, significantly speeding up the documentation process.

Quick Start

Use the component-docs-writer skill to create documentation for a new Button component.

Frequently Asked Questions about component-docs-writer

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

FAQPage Schema
How do I generate MDX component documentation for a design system?

To generate MDX component documentation, use this Skill to create structured MDX files that include anatomy diagrams, interactive demos, and usage guidelines following established UX principles.

What is the best way to document interactive component demos in MDX?

The best way to document interactive component demos is generating `.demo.tsx` files alongside your MDX documentation to showcase component functionality and ensure accurate rendering.

Does this documentation generator support creating anatomy diagrams for UI components?

Yes, this documentation generator supports creating anatomy diagrams by providing specific instructions and patterns for building clear SVG anatomy diagrams for your components.

Can I use this to write documentation for design system foundations and patterns, not just individual components?

Yes, you can use this to write documentation for design system foundations and patterns, as it supports structured content creation across components, patterns, and foundations.

How do I validate the completeness of generated component documentation?

You validate the completeness of generated component documentation by running the built-in validation scripts that check your MDX files against specific component patterns and required content.