# rakib3004/tech-edu-assistant architecture

> Architecture diagram of the GitHub repository rakib3004/tech-edu-assistant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rakib3004/tech-edu-assistant
- Repository: https://github.com/rakib3004/tech-edu-assistant

## Overview

##### Project type and purpose
- This is a purely static, client-side educational website (“Tech-Edu-Assistant”)
- It is hosted on GitHub Pages and delivers HTML/CSS/asset files to end users’ browsers
- Purpose: organize and serve course materials (HTML pages, PDFs, slide decks) across multiple topics and semesters

##### File structure
- Top-level:
– index.html: main landing page
– css/: all styling sheets (normalize.css, main.css, plus topic-specific CSS)
– doc/: hierarchical content folders (Link1–Link4, Pdf1–Pdf4, SubType1–SubType4, SubjectsGroup, SemestersGroup, VideoLink1–VideoLink4, html/)
– Images/: any static images (if present)
– README.md, .gitignore
- Patterns:
– No server or API code—pure static content
– Content organized by delivery format (HTML links, PDFs, video links) and by topic/subtype
– “doc/html” subfolder holds a separate “Docs Hub” Kiosk site

##### README for additional insights
- Confirms two entry points:
– Main site (index.html)
– Docs Hub (doc/html/HomePage.html)
- No frameworks or build scripts are mentioned—deploy by pushing files to GitHub Pages

##### Components
a. Client (Web Browser)
– Sends HTTP GET requests
– Renders HTML/CSS, downloads assets (PDFs, images, slides)
b. Hosting Platform (GitHub Pages CDN)
– Serves static files directly from the repository
c. Static Asset Store (the Git repo)
– index.html, css/, Images/, doc/
– Organized content collections by topic, format, semester
d. (Optional) CI/CD / GitHub Actions
– If used, could automate checks or deploy to Pages on push

##### Relationships and data flow
– User → Browser: enters URL
– Browser → GitHub Pages: requests index.html or docs pages
– Pages → Browser: responds with HTML
– Browser → Browser: loads CSS, images, PDF/slide assets from the same host
– Internal navigation: hyperlinks point to files under doc/

##### Architectural patterns & principles
- Single-page / multi-page static architecture
- Separation of concerns:
– Presentation (css/)
– Content (doc/, html/)
- Content-driven navigation: file-based directory reuse for every subject and semester

##### Technologies & frameworks
– HTML5, CSS3 (no JavaScript frameworks detected)
– Git & GitHub Pages for versioning and hosting
– Standard file formats: .html, .css, .pdf

##### Detailed guidance
– Group css/, Images/, index.html under a “Main Site” cluster
– Group doc/html under “Docs Hub” cluster
– Inside each cluster, show sub-folders that represent major content types
– Indicate hyperlinks from main site to docs hub and within docs hub to subfolders

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients
    Browser["User Browser"]:::component

    %% CDN
    CDN["GitHub Pages CDN"]:::cdn

    %% Static Asset Store
    subgraph "Static Asset Store (Git Repo)"
        direction TB
        subgraph "Main Education Portal"
            direction TB
            index["index.html"]:::content
            css["css/"]:::content
            Images["Images/"]:::content
        end
        subgraph "Course Content Collections"
            direction TB
            DocRoot["doc/"]:::content
            subgraph "HTML Links Collection"
                direction TB
                Link1["Link1/"]:::collection
                Link2["Link2/"]:::collection
                Link3["Link3/"]:::collection
                Link4["Link4/"]:::collection
            end
            subgraph "PDF Materials Collection"
                direction TB
                Pdf1["Pdf1/"]:::collection
                Pdf2["Pdf2/"]:::collection
                Pdf3["Pdf3/"]:::collection
                Pdf4["Pdf4/"]:::collection
            end
            subgraph "Video Links Collection"
                direction TB
                Video1["VideoLink1/"]:::collection
                Video2["VideoLink2/"]:::collection
                Video3["VideoLink3/"]:::collection
                Video4["VideoLink4/"]:::collection
            end
            subgraph "Content Organization by Subject Type"
                direction TB
                Sub1["SubType1/"]:::collection
                Sub2["SubType2/"]:::collection
                Sub3["SubType3/"]:::collection
                Sub4["SubType4/"]:::collection
            end
            SubjectsGroup["SubjectsGroup/"]:::collection
            SemestersGroup["SemestersGroup/"]:::collection
        end
        subgraph "Docs Hub Portal"
            direction TB
            HomePage["HomePage.html"]:::content
            subgraph "Docs Hub Assets"
                direction TB
                Books["Books.html"]:::collection
                Subjects["Subjects.html"]:::collection
                Semesters["Semesters.html"]:::collection
                StyleDoc["Style.css"]:::collection
                IIT["IIT_Syllabus.pdf"]:::collection
                GithubDoc["Github.html"]:::collection
            end
        end
    end

    %% Data Flow
    Browser -->|"HTTP GET index.html"| CDN
    CDN -->|serves| index
    CDN -->|serves| css
    CDN -->|serves| Images
    CDN -->|serves| DocRoot
    index -->|"link to Docs Hub"| HomePage
    HomePage -->|loads assets| Books
    HomePage -->|loads assets| Subjects
    HomePage -->|loads assets| Semesters
    HomePage -->|loads assets| StyleDoc
    HomePage -->|loads assets| IIT
    HomePage -->|loads assets| GithubDoc

    %% Click Events
    click index "https://github.com/rakib3004/tech-edu-assistant/blob/main/index.html"
    click css "https://github.com/rakib3004/tech-edu-assistant/tree/main/css/"
    click Images "https://github.com/rakib3004/tech-edu-assistant/tree/main/Images/"
    click DocRoot "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/"
    click Link1 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Link1/"
    click Link2 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Link2/"
    click Link3 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Link3/"
    click Link4 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Link4/"
    click Pdf1 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Pdf1/"
    click Pdf2 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Pdf2/"
    click Pdf3 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Pdf3/"
    click Pdf4 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/Pdf4/"
    click Video1 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/VideoLink1/"
    click Video2 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/VideoLink2/"
    click Video3 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/VideoLink3/"
    click Video4 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/VideoLink4/"
    click Sub1 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SubType1/"
    click Sub2 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SubType2/"
    click Sub3 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SubType3/"
    click Sub4 "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SubType4/"
    click SubjectsGroup "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SubjectsGroup/"
    click SemestersGroup "https://github.com/rakib3004/tech-edu-assistant/tree/main/doc/SemestersGroup/"
    click HomePage "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/HomePage.html"
    click Books "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/Books.html"
    click Subjects "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/Subjects.html"
    click Semesters "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/Semesters.html"
    click StyleDoc "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/Style.css"
    click IIT "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/IIT_Syllabus.pdf"
    click GithubDoc "https://github.com/rakib3004/tech-edu-assistant/blob/main/doc/html/Github.html"

    %% Styles
    classDef component fill:#AEDFF7,stroke:#036,stroke-width:1px
    classDef cdn fill:#BEE7FD,stroke:#036,stroke-width:1px
    classDef content fill:#D0EEC9,stroke:#069,stroke-width:1px
    classDef collection fill:#C8F7C5,stroke:#060,stroke-width:1px
```
