# mr-ahtashamulhaq/icodeguru-meps-uet architecture

> Architecture diagram of the GitHub repository mr-ahtashamulhaq/icodeguru-meps-uet, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mr-ahtashamulhaq/icodeguru-meps-uet
- Repository: https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet

## Overview

##### Project type and purpose
- This is a documentation/content repository for a six-week “TECH-SAVVY 2025” course.
- It primarily holds course notes (`.md`) and code samples (`.py`, though none shown in the tree), organized by week and day.
- There is no dynamic backend service—content is static and meant for reading or static-site publication (e.g., GitHub Pages, MkDocs, Jekyll).

##### File structure
- Top-level:
- README.md (course overview)
- WEEK-01 … WEEK-06 folders
- Each WEEK-XX folder contains daily markdown files (`Day_##_Class_##_… .md`).
- No build scripts or configuration files are present, which suggests it’s a pure content repo (no custom static-site config checked in).

##### README for additional insights
- Duration, language (Python), topics (Python, AI, digital presence, FAANG prep).
- Mentions code (`.py`) or notes (`.md`) per day/week—so the repository is the single source of truth for all materials.

a. Main components
- Content Repository (Markdown + Python code files)
- Version Control (Git/GitHub)
- Static Site Generator (SSG) – e.g., MkDocs, Jekyll, Sphinx, or a custom Python script
- Continuous Integration/Deployment (CI/CD) – GitHub Actions or similar
- Hosting Service – GitHub Pages, Netlify, or any static-host
- End Users – students or developers viewing the course materials via a browser

b. Relationships and interactions
1. Developer commits content (MD + PY) to the GitHub repo.
2. GitHub triggers CI/CD pipeline on push.
3. CI/CD invokes the SSG to transform MD into HTML.
4. Generated HTML/CSS/JS is published to the hosting service.
5. End users browse to the site URL and consume the content.

c. Architectural patterns/design principles
- Static Site Architecture: no runtime server, purely build‐time content rendering.
- GitOps: content-as-code, all changes go through version control.
- CI/CD Pipeline: automated build and deploy on each commit.

d. Relevant technologies/frameworks
- Git/GitHub for version control and hosting (Pages).
- Static Site Generator:
– MkDocs or Sphinx (Python-based)
– Jekyll (Ruby-based)
– Custom Python build scripts (if code samples require execution or embedding outputs).
- CI/CD: GitHub Actions workflows or equivalent.

##### Detail
- Logical step: version control, build, deploy, serve.
- Manual vs. automated processes.
- Don’t overthink—break it into the six or seven components above and show the data flows clearly.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    subgraph "Developer Environment"
        Dev["Developer"]:::developer
        Local["Local Preview (mkdocs serve)"]:::process
    end

    %% Content Repository
    subgraph "Content Repository"
        Repo["GitHub Repo"]:::repo
        README["README.md"]:::repo
        W1["WEEK-01/"]:::repo
        W2["WEEK-02/"]:::repo
        W3["WEEK-03/"]:::repo
        W4["WEEK-04/"]:::repo
        W5["WEEK-05/"]:::repo
        W6["WEEK-06/"]:::repo
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        CI["GitHub Actions"]:::ci
        Build["SSG Build (MkDocs/Sphinx)"]:::ci
    end

    %% Hosting & Delivery
    subgraph "Hosting & Delivery"
        Host["GitHub Pages"]:::hosting
        Browser["End User Browser"]:::user
    end

    %% Connections
    Dev -->|"commits content"| Repo
    Dev -->|"preview locally"| Local
    Repo -->|"push triggers"| CI
    CI -->|"runs build"| Build
    Build -->|"deploy static site"| Host
    Browser -->|"requests site"| Host
    Host -->|"serves content"| Browser

    %% Click Events
    click README "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/blob/main/README.md"
    click W1 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-01/"
    click W2 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-02/"
    click W3 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-03/"
    click W4 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-04/"
    click W5 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-05/"
    click W6 "https://github.com/mr-ahtashamulhaq/icodeguru-meps-uet/tree/main/WEEK-06/"

    %% Styles
    classDef developer fill:#E0F7FA,stroke:#0288D1,color:#000
    classDef process fill:#B2EBF2,stroke:#00796B,color:#000
    classDef repo fill:#E8F5E9,stroke:#388E3C,color:#000
    classDef ci fill:#FFF9C4,stroke:#FBC02D,color:#000
    classDef hosting fill:#FFF3E0,stroke:#FB8C00,color:#000
    classDef user fill:#F3E5F5,stroke:#8E24AA,color:#000
```
