Imported from tomevault-io/tomes (
leboncoin--spark-web/skills/cursor-skills-create-storybook-docs-skill-b1e12204e4578e97/SKILL.md). Install upstream withnpx skills add tomevault-io/tomes --skill cursor-skills-create-storybook-docs-skill-b1e12204e4578e97. Copyright stays with the author.
Create Storybook Documentation
Create or update Storybook stories and MDX documentation for Spark UI components.
When to Use
- User wants to add Storybook stories
- User wants to update component documentation
- Component is missing stories or documentation
- User mentions "stories", "storybook", or "documentation"
Instructions
Stories File (ComponentName.stories.tsx)
-
Meta Definition:
const meta: Meta<typeof ComponentName> = { title: 'Components/ComponentName', component: ComponentName, } export default meta -
Story Guidelines:
- Use
*.stories.tsxextension - One story per prop/feature (avoid mixing many props)
- Use
Components/*meta structure - Avoid
_argswhen using JS logic (useState, etc.) - Include all variants and states
- Use
-
Required Stories (in order):
Default: Minimal common caseUncontrolled: Stateful with internal stateControlled: Stateless with props- Other variants alphabetically
Documentation File (ComponentName.doc.mdx)
-
Sections Order (must follow this exact order):
- Title: H1 heading with component description
- Meta: Link to stories using
<Meta of={stories} /> - Install: Installation instructions
- Import: Import examples
- Props table: Use custom
ArgTypescomponent - Usage: Examples in specific order (Default, Uncontrolled, Controlled, others alphabetically)
- Advanced Usage: Complex examples and edge cases
- Accessibility: Keyboard interactions and a11y requirements
-
Usage Section Format:
## Usage ### Default <Canvas of={stories.Default} /> ### Uncontrolled Description of uncontrolled usage. <Canvas of={stories.Uncontrolled} /> ### Controlled Description of controlled usage. <Canvas of={stories.Controlled} /> -
For Compound Components:
- Use
ArgTypeswithsubcomponentsprop - Document each sub-component separately
- Use
Reference
See documentation/contributing/WritingStories.mdx for complete guidelines.
Examples
Reference existing stories in packages/components/src/*/ComponentName.stories.tsx and ComponentName.doc.mdx.
Source: leboncoin/spark-web — distributed by TomeVault.