How event-catalog/eventcatalog works
Main Components Identification
a) Core Application Components:
• Content Generation Engine (src/generate.js)
• File System Watcher (src/watcher.js)
• Configuration Manager (src/eventcatalog-config/)
• Collection Processors (src/utils/collections/)
• Node Graph Generators (src/utils/node-graphs/)
b) Frontend Components:
• MDX Components (eventcatalog/src/components/MDX/)
• Visualization Components (eventcatalog/src/components/MDX/NodeGraph/)
• UI Components (eventcatalog/src/components/)
• Routing System (eventcatalog/src/pages/)
┌─ User Interface Layer ─────────────────────┐
• Documentation Pages │
• Visualizer │
• Discovery Interface │
• Search Component │
• Application Layer ──────────────────────┐ │
• Content Generation Engine │ │
• MDX Processing │ │
• Node Graph Generation │ │
• Schema Processing │ │
• Data Layer ───────────────────────────┐ │ │
• Markdown Files │ │ │
• Schema Files │ │ │
• Configuration Files │ │ │
• Version Control │ │ │
• ┴─┴─┘
Component Relationships
• Content Generation Engine → MDX Processing → UI Components
• File System Watcher → Content Generation Engine
• Node Graph Generators → Visualization Components
• Collection Processors → Documentation Pages
• Configuration Manager → All Components
Component Details
For each major component, include:
• Input/Output relationships
• Key responsibilities
• Technology stack (Astro, React, TypeScript)
• Integration points
Architectural Patterns
Following patterns:
• Event-Driven Documentation
• Component-Based UI
• Plugin Architecture
• Version Control Integration
• Static Site Generation
Remember to maintain a balance between detail and clarity, focusing on the core functionality while still showing the extensibility and flexibility of the system.
This system design should help developers understand how EventCatalog transforms markdown-based documentation into an interactive, searchable, and visually appealing documentation platform for event-driven architectures.