How aiinminutes/data-and-ai-concepts works
Project Type and Purpose
• This is *neither* a typical full-stack web application nor a microservice. It’s a content-centric static site repository that holds Jupyter notebooks, slides, infographics, and Markdown. The ultimate goal is to publish an educational “book” and accompanying website (hosted at aiinminutes.github.io) covering Data Science and AI concepts.
File-Structure Analysis
• Top-level files:
• README.md – project overview & navigation table
• LICENSE.md, .gitignore – metadata & VCS config
• iqs/ – interactive notebooks for IQ questions
• notebooks/ – conceptual notebooks, organized by topic
• slides/ – PDF lecture slides
• No “src” or “backend” folders—this is purely static content. There are no build scripts or explicit CI/CD configs checked in, but the README references a GitHub Pages site.
Architectural Ingredients (to appear
A. Content Repository (GitHub)
• Stores Jupyter notebooks, PDFs, Markdown, media assets.
• Manages version history, branching, PRs.
B. Static-Site Generator (SSG)
• Tool (e.g., Jekyll, MkDocs, Hugo) transforms notebooks & Markdown into HTML.
• May run via GitHub Actions or external CI.
C. Continuous Integration / Deployment
• On pushes to main, CI builds the site, runs notebook-to-HTML conversion, checks links.
• CI publishes built site artifacts.
D. Hosting Platform
• GitHub Pages (or Netlify/Vercel) serves the static HTML, assets (PDFs, images).
E. End Users
• Learners who browse the interactive site in their browser.
• Optionally clone the repo to run notebooks locally in Jupyter.
Relationships & Data Flows
1. Developer Workflow
• Author updates or adds notebooks/Markdown → pushes to GitHub.
2. CI/CD Pipeline
• GitHub Actions triggered → runs SSG (converts notebooks & Markdown → HTML), packages assets.
3. Publishing
• CI deploys build output to GitHub Pages (gh-pages branch or docs/ folder).
4. User Access
• End users request pages via browser → hosting platform responds with static HTML/CSS/JS + PDFs/Jupyter links.
Key Design Principles
• Separation of Concerns:
• Content storage (Git repo) vs. content rendering (SSG) vs. content delivery (host).
• Immutable Deployments:
• Each build produces a static snapshot—no server-side code.
• Scalability & Performance:
• Static assets served via CDN edge caches.
• Extensibility:
• New notebooks or slides simply drop into appropriate directory; SSG picks them up automatically.
Essential Elements to Capture
• Clear Labels: Name each component (e.g., “GitHub Repo (Content)”).