# temporalio/temporal-learning architecture

> Architecture diagram of the GitHub repository temporalio/temporal-learning, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/temporalio/temporal-learning
- Repository: https://github.com/temporalio/temporal-learning

## Overview

##### Main Components

a. Content Layer:
- Markdown Documentation Files (in /docs)
- Course Content (synced from external LMS)
- Code Snippets (from external GitHub repositories)
- Static Assets (images, PDFs, etc. in /static)

b. Build System:
- Docusaurus Engine
- Custom Components (in /src/components)
- Theme Customizations (in /src/theme)
- Style Processing (CSS modules)

c. Integration Services:
- Snipsync Integration (for code snippets)
- LMS Integration (for course content)
- Vale Style Checker
- Link Checker (Lychee)

d. Build Pipeline:
- Development Server
- Production Build Process
- Content Validation Tools

##### Relationships

**Content Sources → Build Pipeline → Output**
- Markdown Files ──┐
- LMS Content ────┤
- Code Snippets ──┤
- Static Assets ──┘

##### Specific processes

**External Sources → Content Processing → Build → Validation → Deployment**
- LMS API        └── Snipsync         └── Docusaurus  └── Vale    └── Static Site
- GitHub         Markdown Processing    Custom Theme    Lychee

##### Key Elements to Highlight

- Content synchronization flows
- Build pipeline stages
- Validation checkpoints
- Development vs. Production paths

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Content
        MD["Markdown Documentation"]
        CC["Course Content"]
        CS["Code Snippets"]
        SA["Static Assets"]
    end

    subgraph BuildSystem
        DE["Docusaurus Engine"]
        CU["Custom Components"]
        TH["Theme Customization"]
        ST["Style Processing"]
        DC["Docusaurus Config"]
    end

    subgraph Integration
        SN["Snipsync Integration"]
        LM["LMS Integration"]
        VS["Vale Style Checker"]
        LC["Link Checker"]
    end

    subgraph Pipeline
        DS["Development Server"]
        PB["Production Build"]
        CV["Content Validation"]
    end

    %% Content Flow
    MD --> DE
    CC --> DE
    CS --> DE
    SA --> DE

    %% Build System
    DE --> DS
    DE --> PB
    CU --> DE
    TH --> DE
    ST --> DE
    DC --> DE

    %% Integration Services
    SN --> CS
    LM --> CC
    VS --> CV
    LC --> CV

    %% Pipeline Flow
    CV --> PB
    DS --> CV

    %% Styling
    classDef content fill:#a8d1f0
    classDef build fill:#90EE90
    classDef integration fill:#FFE5B4
    classDef pipeline fill:#D3D3D3

    class MD,CC,CS,SA content
    class DE,CU,TH,ST,DC build
    class SN,LM,VS,LC integration
    class DS,PB,CV pipeline

    %% Click Events
    click MD "https://github.com/temporalio/temporal-learning/tree/main/docs"
    click CC "https://github.com/temporalio/temporal-learning/tree/main/docs/courses"
    click SA "https://github.com/temporalio/temporal-learning/tree/main/static"
    click CU "https://github.com/temporalio/temporal-learning/tree/main/src/components"
    click TH "https://github.com/temporalio/temporal-learning/tree/main/src/theme"
    click ST "https://github.com/temporalio/temporal-learning/blob/main/src/css/custom.css"
    click DC "https://github.com/temporalio/temporal-learning/blob/main/docusaurus.config.js"
    click VS "https://github.com/temporalio/temporal-learning/tree/main/vale/styles"
    click SN "https://github.com/temporalio/temporal-learning/blob/main/snipsync.config.yaml"
    click LM "https://github.com/temporalio/temporal-learning/blob/main/get_course_pages_from_lms.js"
    click CV "https://github.com/temporalio/temporal-learning/tree/main/vale/test"

    %% Legend
    subgraph Legend
        L1["Content Files"]:::content
        L2["Build Components"]:::build
        L3["External Integrations"]:::integration
        L4["Pipeline Processes"]:::pipeline
    end
```
