ds-document-component

Generate six MDX documentation subpages for Baloise Design System components.

111|29|Updated Oct 4, 2019
One-click install
npx skills add https://github.com/baloise/design-system --skill ds-document-component
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ds-document-component
Source: https://github.com/baloise/design-system/tree/main/.claude/skills/ds-document-component
Command: npx skills add https://github.com/baloise/design-system --skill ds-document-component

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires storybook, storybook-html-vite, mdx, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive Storybook documentation for Baloise Design System components, saving developers time and ensuring consistency.

Core Features & Use Cases

  • Documentation Generation: Automatically generates Overview, Usage, Variants, Styling, Accessibility, and Testing documentation.
  • Storybook Integration: Uses Storybook's blocks and templates for seamless integration.
  • Type-dependent Canvas: Supports different component types (WC-only, hybrid, CSS-only) with appropriate Canvas components.
  • Story Variants: Creates dual variants for web components and HTML/CSS classes.
  • Use Case: Generate full documentation for a Baloise Design System component in a few steps.

Quick Start

Run the 'generate-documentation' command with the component name as an argument.

Frequently Asked Questions about ds-document-component

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

FAQPage Schema
How do I automate Storybook documentation generation for design system components?

You need Storybook installed with reusable Storybook blocks and templates. The Skill uses storybook-html-vite and MDX to generate documentation, requiring these dependencies to be present in your project environment before running the generation command.

Does this Storybook documentation approach support CSS-only components or only web components?

The Storybook documentation approach supports multiple component types including web components only, hybrid components, and CSS-only components. It generates dual story variants for web components and HTML/CSS classes, adapting the Canvas component based on the component type.

What is the best way to create consistent MDX documentation pages across a design system?

The best way to create consistent MDX documentation is to automate generation using Storybook's built-in blocks and templates. This produces six standardized subpages per component, ensuring uniform documentation structure across the entire Baloise Design System without manual writing.

How do I generate the six standard documentation pages for a new Baloise Design System component?

Generate the six standard documentation pages by running the generate-documentation command with the component name as an argument. This automatically produces the Overview, Usage, Variants, Styling, Accessibility, and Testing MDX subpages using reusable Storybook blocks.

Can I use this to add Accessibility and Testing documentation sections to existing Storybook stories?

Yes, the generated MDX documentation includes dedicated Accessibility and Testing subpages. By running the generation command, these sections are automatically created using Storybook's blocks and templates, integrating seamlessly with your existing component stories.