How aditya-jai/computer-science works
Project Type and Purpose
• This is a documentation website for the Open Source Society University (OSSU) computer-science curriculum.
• It’s implemented as a static site using Jekyll and hosted via GitHub Pages.
• The README makes clear that the repo’s role is to present curriculum content (Markdown course pages, extras, guidelines) and coordinate contributions and community engagement.
File Structure Analysis
• Top-level files:
• .github/ – issue templates & CI workflows (GitHub Actions)
• _config.yml – Jekyll site configuration
• _includes/, _layouts/ – Jekyll partials and page layouts
• _site/ (implicitly, generated output)
• coursepages/, extras/, images/ – source content
• README.md, CONTRIBUTING.md, FAQ.md etc. – site pages
• No backend code or dynamic services—purely a build-and-deploy pipeline.
Key Components
a. Version Control (GitHub)
• Repo containing source Markdown, templates, config, images.
• Branches and pull requests as contribution flow.
b. Continuous Integration (GitHub Actions)
• Workflow .github/workflows/delete-empty-issues.yml (and potentially others) runs on push/PR.
• Steps: checkout → Jekyll build → link checks / lint → automatic cleanup tasks.
c. Static Site Generator (Jekyll)
• Reads _config.yml, _includes/, _layouts/, plus Markdown in coursepages/, extras/, root.
• Produces HTML/CSS/JS static assets.
d. Hosting & Delivery (GitHub Pages)
• Deploys the generated _site/ to gh-pages or master branch.
• Serves content at ossu.cs/ via CNAME.
e. Consumers (Web Browsers)
• End-users access the site via browser over HTTPS.
f. Optional Local Development
• Developer machine runs jekyll serve with Ruby, bundler, local preview.
Relationships and Data Flow
1. Developer clones repo → edits Markdown, templates, or config → commits & pushes.
2. GitHub Actions triggers on push/PR:
• Lints Markdown, removes stale issues, builds site.
3. On successful build, Actions deploy static _site/ to Pages branch.
4. GitHub Pages serves static HTML/CSS/JS at the custom domain.
5. End-user browser requests pages → delivered by GitHub Pages CDN.
Architectural Patterns & Principles
• Separation of Concerns:
• Source content vs. templates/layouts
• CI/CD pipeline separate from hosting
• Infrastructure as Code:
• GitHub workflows declared in YAML
• Content-First Architecture:
• Curriculum content is primary; site generator patterns support assembly.
• Community & Contribution Model:
• Issue templates and CONTRIBUTING guide embedded in repo.