How worldline/learning-ai works
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.