How rakib3004/tech-edu-assistant works
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