# worldline/learning-ai architecture

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

- Interactive diagram: https://gitdiagram.com/worldline/learning-ai
- Repository: https://github.com/worldline/learning-ai

## Overview

##### What this project is (type + purpose)

From the file tree + README, this is **not an application backend** or a microservice system. It’s a **course website/documentation portal** built with **VuePress** (Vue-powered static site generator) and deployed via **GitHub Actions** (see `.github/workflows/vuepress-deploy.yml`).

**Primary purpose:** publish and host a multi-module training (“From Generative to Agentic AI for Developers”) as a navigable documentation site, likely on **GitHub Pages** (common for VuePress deploy workflows).

- Content authoring (Markdown + assets + a few Vue components)
- Static build (VuePress compiles to HTML/CSS/JS)
- CI/CD pipeline (GitHub Actions)
- Hosting + delivery to browsers (GitHub Pages / static hosting)
- Optional PWA elements (manifest present)

##### Top-level
- `.github/workflows/vuepress-deploy.yml`
- `docs/`
→ The actual VuePress project root (contains `package.json`, `src/`).
- `others/`
→ Non-site artifacts (pptx, plan). Not part of runtime; optional to show as “source materials”.

##### VuePress app structure
- `docs/package.json`, `docs/package-lock.json`
→ Node toolchain, dependencies, build scripts.
- `docs/src/`
→ Documentation source (Markdown modules + VuePress config + assets).
- `docs/src/.vuepress/config.ts`
→ **Site architecture definition**: nav, sidebar, theme config, plugins. This is the “composition root” of the site.
- `docs/src/.vuepress/client.ts`
→ Client-side enhancements / bootstrapping hooks (VuePress client entry).
- `docs/src/.vuepress/public/manifest.webmanifest`
→ PWA/public static assets copied as-is to output.
- `docs/src/.vuepress/styles/index.scss`
→ Global styling pipeline.

##### Content modules (course structure = IA of the site)
- `docs/src/1.intro/README.md`
- `docs/src/2.prompt/README.md`
- …
- `docs/src/8.cloud/README.md`

##### Interactive bits
- `docs/src/5.services/RestLlmTester.vue`

##### Static assets
- `docs/src/assets/images`, `docs/src/assets/sources` (pptx/pdf)
→ Inputs to the site build (some may be linked/downloaded).

##### What the README adds (system context)

The README describes a training spanning:
- Prompting
- LLM clients, RAG
- Code assistants
- Services with structured outputs
- Agentic AI, MCP
- Node-based tools (n8n)
- Cloud tools (Vertex AI, Colab)

- **“This repo’s architecture”** (VuePress site + deployment)
vs

##### Content Authoring Layer
- Markdown modules (`docs/src/**/README.md`, `docs/src/index.md`)
- Vue components embedded in docs (`RestLlmTester.vue`)
- Assets (images, pptx/pdf sources)

##### Static Site Generator / Build Layer
- VuePress engine (Node.js build)
- VuePress config (`.vuepress/config.ts`)
- Client enhancements (`.vuepress/client.ts`)
- Styling (`.vuepress/styles/index.scss`)
- Public static files (`.vuepress/public/*` including `manifest.webmanifest`)

##### CI/CD Layer
- GitHub Actions workflow (`.github/workflows/vuepress-deploy.yml`)
- checkout
- install dependencies (`npm ci` / `npm install`)
- build site (VuePress build)
- publish artifact / deploy to Pages branch/environment

##### Hosting/Delivery Layer
- GitHub Pages (or equivalent static hosting destination implied by deploy workflow)
- CDN-like static delivery (GitHub Pages acts as edge distribution)

##### Runtime (Browser) Layer
- Rendered static pages (HTML/CSS)
- JS bundle (Vue runtime from VuePress)
- Optional PWA behavior (manifest suggests installability/offline depending on config/plugins)
- Interactive component runtime (`RestLlmTester.vue` runs here)

##### External Systems (only if evidenced / or explicitly marked optional)
- If `RestLlmTester.vue` calls an LLM endpoint (not shown in tree), represent as:
- “External LLM API (optional / configured elsewhere)”

##### Architectural patterns/design principles to highlight (specific to this repo)

- **Static Site Generation (SSG)**: compile-time generation, minimal server-side runtime.
- **Content-as-code**: course modules are versioned Markdown; updates are PR-based.
- **CI/CD as deployment mechanism**: GitHub Actions is the “release pipeline”.
- **Client-side enhancement**: VuePress supports interactive Vue components embedded in otherwise static content.
- **Separation of concerns**:
- content (`docs/src/*`) vs framework plumbing (`docs/src/.vuepress/*`) vs delivery pipeline (`.github/workflows/*`)

##### Source / Authoring
- Markdown modules (1.intro … 8.cloud)
- Vue components (RestLlmTester.vue)
- Assets (images, pdf/pptx)

##### Build System (Node/VuePress)
- VuePress CLI/build
- config.ts / client.ts
- styles pipeline
- public/manifest

##### CI/CD (GitHub Actions)
- vuepress-deploy workflow
- build step
- deploy step

##### Hosting + Runtime
- GitHub Pages (static hosting)
- Browser (VuePress runtime)
- PWA manifest (optional)
- Interactive component execution

##### “Don’t overthink it” rule applied here

Focus: VuePress build → GitHub Actions → GitHub Pages → Browser.

Focus: modules 1–8, and where interactive demos (like `RestLlmTester.vue`) appear.

This avoids mixing “course syllabus domains” with “deployment architecture” in one overloaded drawing.

## Diagram (Mermaid)

```mermaid
flowchart TD

%% =========================
%% Diagram 1: Build + Delivery Architecture (Vertical)
%% =========================

subgraph "Source Repository (Git)"
  direction TB

  subgraph "CI/CD Definitions"
    direction TB
    GH_Workflow["GitHub Actions Workflow\n(vuepress-deploy.yml)"]:::cicd
  end

  subgraph "VuePress Workspace"
    direction TB
    DocsRoot["VuePress Project Root\n(docs/)"]:::repo

    subgraph "Node Toolchain"
      direction TB
      Pkg["package.json\n(deps & scripts)"]:::build
      Lock["package-lock.json\n(lockfile)"]:::build
    end

    subgraph "Documentation Source (docs/src/)"
      direction TB
      SrcRoot["Source Root\n(docs/src/)"]:::repo

      subgraph "Course Content (Markdown)"
        direction TB
        IndexMd["Landing Page\n(index.md)"]:::content
        M1["Module 1: Intro\nREADME.md"]:::content
        M2["Module 2: Prompt\nREADME.md"]:::content
        M3["Module 3: Client\nREADME.md"]:::content
        M4["Module 4: Assistant\nREADME.md"]:::content
        M5["Module 5: Services\nREADME.md"]:::content
        M6["Module 6: Agentic\nREADME.md"]:::content
        M7["Module 7: Node\nREADME.md"]:::content
        M8["Module 8: Cloud\nREADME.md"]:::content
      end

      subgraph "Interactive Components (embedded in pages)"
        direction TB
        RestTester["RestLlmTester.vue\n(Interactive Demo UI)"]:::frontend
      end

      subgraph "VuePress App Plumbing (.vuepress)"
        direction TB
        Config["config.ts\n(nav/sidebar/theme/plugins)"]:::build
        Client["client.ts\n(client enhancements)"]:::build
        Styles["styles/index.scss\n(global styles)"]:::build

        subgraph "Public Static Files"
          direction TB
          PublicDir["public/\n(copied as-is)"]:::build
          Manifest["manifest.webmanifest\n(PWA metadata)"]:::build
        end
      end

      subgraph "Assets"
        direction TB
        AssetsRoot["assets/"]:::content
        Images["assets/images/"]:::content
        Sources["assets/sources/\n(pptx/pdf)"]:::content
        ImgA["4.assistant/images/"]:::content
        ImgS["5.services/images/"]:::content
        ImgN["7.node/images/"]:::content
      end
    end
  end

  subgraph "Non-site Materials (out of runtime)"
    direction TB
    Others["others/"]:::note
    PPTX["Training AI.pptx"]:::note
    Plan["plan.md"]:::note
  end
end

subgraph "Build System (Node + VuePress SSG)"
  direction TB
  BuildCmd["VuePress Build\n(SSG compile to static HTML/CSS/JS)"]:::build
  Dist["Build Output\n(static dist/)"]:::artifact
end

subgraph "CI/CD Runtime (GitHub Actions)"
  direction TB
  GA["GitHub Actions Runner"]:::cicd
  StepCheckout["Step: checkout"]:::cicd
  StepInstall["Step: install\n(npm ci / npm install)"]:::cicd
  StepBuild["Step: build\n(vuepress build)"]:::cicd
  StepDeploy["Step: deploy\n(publish to Pages)"]:::cicd
end

subgraph "Hosting + Delivery"
  direction TB
  Pages["GitHub Pages\n(static hosting)"]:::hosting
  CDN["Static Delivery Edge\n(Pages/CDN-like)"]:::hosting
end

subgraph "Browser Runtime"
  direction TB
  Browser["User Browser"]:::runtime
  Rendered["Rendered Pages\n(HTML/CSS)"]:::runtime
  JsBundle["JS Bundle\n(VuePress/Vue runtime)"]:::runtime
  PWA["PWA Installability/Offline (optional)\n(via manifest)"]:::runtime
  RestRuntime["RestLlmTester Runtime\n(component execution)"]:::runtime
end

ExternalAPI["External REST/LLM Endpoint\n(optional; configured elsewhere)"]:::external

%% ---- Relationships (Authoring -> Build) ----
DocsRoot -->|"contains"| SrcRoot
Pkg -->|"drives build scripts"| BuildCmd
Lock -->|"pins dependencies"| BuildCmd

IndexMd -->|"content"| BuildCmd
M1 -->|"content"| BuildCmd
M2 -->|"content"| BuildCmd
M3 -->|"content"| BuildCmd
M4 -->|"content"| BuildCmd
M5 -->|"content"| BuildCmd
M6 -->|"content"| BuildCmd
M7 -->|"content"| BuildCmd
M8 -->|"content"| BuildCmd

RestTester -->|"bundled into"| BuildCmd

Config -->|"configures"| BuildCmd
Client -->|"enhances client runtime"| BuildCmd
Styles -->|"compiled into CSS"| BuildCmd
PublicDir -->|"copied into"| Dist
Manifest -->|"included in"| Dist

AssetsRoot -->|"packaged/linked"| BuildCmd
Images -->|"images"| BuildCmd
Sources -->|"downloads"| BuildCmd
ImgA -->|"module assets"| BuildCmd
ImgS -->|"module assets"| BuildCmd
ImgN -->|"module assets"| BuildCmd

BuildCmd -->|"produces"| Dist

%% ---- CI/CD Pipeline ----
GH_Workflow -->|"triggers"| GA
GA --> StepCheckout --> StepInstall --> StepBuild --> StepDeploy
StepBuild -->|"invokes"| BuildCmd
Dist -->|"artifact"| StepDeploy
StepDeploy -->|"publishes"| Pages
Pages -->|"serves"| CDN

%% ---- Delivery to Browser ----
CDN -->|"downloads"| Browser
Browser -->|"renders"| Rendered
Browser -->|"executes"| JsBundle
Manifest -->|"enables"| PWA
JsBundle -->|"runs component"| RestRuntime

%% ---- Optional external call (dotted) ----
RestRuntime -.->|"optional_api_call"| ExternalAPI

%% ---- Non-site materials (optional linkage) ----
Others -.->|"reference_only"| SrcRoot
PPTX -.->|"source_material"| Others
Plan -.->|"source_material"| Others

%% =========================
%% Click Events (from component mapping)
%% =========================
click GH_Workflow "https://github.com/worldline/learning-ai/blob/main/.github/workflows/vuepress-deploy.yml"
click DocsRoot "https://github.com/worldline/learning-ai/tree/main/docs/"
click Pkg "https://github.com/worldline/learning-ai/blob/main/docs/package.json"
click Lock "https://github.com/worldline/learning-ai/blob/main/docs/package-lock.json"
click SrcRoot "https://github.com/worldline/learning-ai/tree/main/docs/src/"
click Config "https://github.com/worldline/learning-ai/blob/main/docs/src/.vuepress/config.ts"
click Client "https://github.com/worldline/learning-ai/blob/main/docs/src/.vuepress/client.ts"
click Styles "https://github.com/worldline/learning-ai/blob/main/docs/src/.vuepress/styles/index.scss"
click PublicDir "https://github.com/worldline/learning-ai/tree/main/docs/src/.vuepress/public/"
click Manifest "https://github.com/worldline/learning-ai/blob/main/docs/src/.vuepress/public/manifest.webmanifest"
click IndexMd "https://github.com/worldline/learning-ai/blob/main/docs/src/index.md"
click M1 "https://github.com/worldline/learning-ai/blob/main/docs/src/1.intro/README.md"
click M2 "https://github.com/worldline/learning-ai/blob/main/docs/src/2.prompt/README.md"
click M3 "https://github.com/worldline/learning-ai/blob/main/docs/src/3.client/README.md"
click M4 "https://github.com/worldline/learning-ai/blob/main/docs/src/4.assistant/README.md"
click M5 "https://github.com/worldline/learning-ai/blob/main/docs/src/5.services/README.md"
click RestTester "https://github.com/worldline/learning-ai/blob/main/docs/src/5.services/RestLlmTester.vue"
click M6 "https://github.com/worldline/learning-ai/blob/main/docs/src/6.agentic/README.md"
click M7 "https://github.com/worldline/learning-ai/blob/main/docs/src/7.node/README.md"
click M8 "https://github.com/worldline/learning-ai/blob/main/docs/src/8.cloud/README.md"
click AssetsRoot "https://github.com/worldline/learning-ai/tree/main/docs/src/assets/"
click Images "https://github.com/worldline/learning-ai/tree/main/docs/src/assets/images/"
click Sources "https://github.com/worldline/learning-ai/tree/main/docs/src/assets/sources/"
click ImgA "https://github.com/worldline/learning-ai/tree/main/docs/src/4.assistant/images/"
click ImgS "https://github.com/worldline/learning-ai/tree/main/docs/src/5.services/images/"
click ImgN "https://github.com/worldline/learning-ai/tree/main/docs/src/7.node/images/"
click Others "https://github.com/worldline/learning-ai/tree/main/others/"
click PPTX "https://github.com/worldline/learning-ai/blob/main/others/Training AI.pptx"
click Plan "https://github.com/worldline/learning-ai/blob/main/others/plan.md"

%% =========================
%% Styles
%% =========================
classDef repo fill:#1f2a44,stroke:#9bb4ff,color:#ffffff,stroke-width:1px
classDef content fill:#1e3a8a,stroke:#93c5fd,color:#ffffff,stroke-width:1px
classDef build fill:#5b21b6,stroke:#c4b5fd,color:#ffffff,stroke-width:1px
classDef cicd fill:#b45309,stroke:#fdba74,color:#ffffff,stroke-width:1px
classDef artifact fill:#6d28d9,stroke:#ddd6fe,color:#ffffff,stroke-width:1px
classDef hosting fill:#166534,stroke:#86efac,color:#ffffff,stroke-width:1px
classDef runtime fill:#065f46,stroke:#6ee7b7,color:#ffffff,stroke-width:1px
classDef external fill:#374151,stroke:#9ca3af,color:#ffffff,stroke-width:1px,stroke-dasharray: 6 4
classDef frontend fill:#0f766e,stroke:#5eead4,color:#ffffff,stroke-width:1px
classDef note fill:#334155,stroke:#cbd5e1,color:#ffffff,stroke-width:1px,stroke-dasharray: 4 3
```
