How imverickz/storybook-deploy works
Main Components of the System
a) Packages (Core Components):
• tokens package (Design Tokens)
• react package (React Components)
• docs package (Documentation/Storybook)
• Shared Configurations (eslint-config, ts-config)
Foundation Layer
• Shared Configurations (TypeScript, ESLint)
Component Layer
• React Components
• Component Styles
• Component Logic
Documentation Layer
• Storybook
• MDX Documentation
• Component Stories
Detailed Component Breakdown
• Individual components (Button, Heading, Text, etc.)
• Their relationship with design tokens
• Style implementation (styled-components)
Build/Deploy Flow
A section showing:
• Turborepo build process
• Changesets for versioning
• GitHub Actions workflow
[Design Tokens] → [React Components] → [Storybook Docs]
• ↑ ↑ ↑
• [Shared Configs]───────────────┘
Key Elements to Emphasize:
Monorepo Structure
• Clear package separation
• Shared dependencies
• Configuration inheritance
Component Architecture
• Token consumption
• Style system integration
• Component composition
Documentation Flow
• Story creation
• MDX integration
• Token visualization
Guidelines for Creation:
Version management flow
Tools Recommendation:
• Use standardized symbols for React/TypeScript
• Package versions in the documentation
Remember to maintain a balance between detail and clarity, focusing on the architectural decisions that make this design system scalable and maintainable.