How mr-ahtashamulhaq/icodeguru-meps-uet works
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.