How optimizely-axiom/optiaxiom works
High-Level Architecture Overview
┌─ Axiom Design System ─────────────────────────────────────┐
• ┌─ Packages ──────────────────────────────────────┐ │
• ┌─ React (@optiaxiom/react) ──────────────┐ │ │
• Components │ │ │
• Hooks │ │ │
• Utilities │ │ │
• ┘ │ │
• ┌─ Web Components ────────────────────┐ │ │
• (@optiaxiom/web-components) │ │ │
• ┘ │ │
• ┌─ Globals ───────────────────────────┐ │ │
• Theme │ │ │
• Tokens │ │ │
• Context │ │ │
• ┘ │ │
• ┘ │
• ┌─ Apps ────────────────────────────────────────┐ │
• ┌─ Documentation ─┐ ┌─ Storybook ─┐ │ │
• ┘ └─────────────┘ │ │
• ┘ │
• ┘
Component Architecture Layer
┌─ Component Architecture ──────────────────────────────┐
• ┌─ Core Components ─────┐ ┌─ Complex Components ─┐ │
• Button │ │ - Dialog │ │
• Input │ │ - DropdownMenu │ │
• Text │ │ - DataTable │ │
• ┘ └────────────────────────┘ │
• ┌─ Layout Components ───┐ ┌─ Feedback Components ─┐ │
• Grid │ │ - Toast │ │
• Flex │ │ - Alert │ │
• ┘ └────────────────────────┘ │
• ┘
┌─ Styling System ────────────────────────────────────┐
• ┌─ Design Tokens ────┐ ┌─ Vanilla Extract ─────┐ │
• Typography │ │ - Recipes │ │
• Spacing │ │ - Global Styles │ │
• Shadows │ └────────────────────────┘ │
• ┘ │
• ┘
Build & Development Infrastructure
Development tooling:
┌─ Development Infrastructure ───────────────────────┐
• ┌─ Build Tools ─────┐ ┌─ Testing ────────────┐ │
• Rollup │ │ - Vitest │ │
• TypeScript │ │ - Testing Library │ │
• ┘ └────────────────────────┘ │
• ┌─ Documentation ────┐ ┌─ Quality Assurance ─┐ │
• Next.js │ │ - ESLint │ │
• MDX │ │ - Prettier │ │
• ┘ └────────────────────────┘ │
• ┘
Key Elements to Include:
• Web Components depending on React components
• Documentation and Storybook depending on all packages
• Components depending on design tokens and styling system
Labels for
• Package versions
• Technology stack used
• Integration points
• Public APIs
Notes on
• Component composition patterns
• Styling methodology
• Build process flow
• Testing strategy