# ossu/data-science architecture

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

- Interactive diagram: https://gitdiagram.com/ossu/data-science
- Repository: https://github.com/ossu/data-science

## Overview

##### Project type and purpose
- This is a **static documentation/curriculum guide** repository for the Open Source Society University Data Science track.
- It’s not a typical full-stack application, but rather a content-centric project that publishes Markdown files (course pages, extras, README) as a browsable website via GitHub Pages (CNAME file present), and supports community contributions via GitHub Issues and Pull Requests.

##### File structure
- Top-level directories:
- `.github/` – CI/workflow definitions (`delete-empty-issues.yml`), issue templates.
- `coursepages/` – per-course Markdown subfolders (`intro-cs`, `intro-programming`).
- `extras/` – supplemental resources (`books.md`, `courses.md`, etc.).
- Root files:
- `README.md` – project overview, curriculum.
- `LICENSE.md` – license.
- `CNAME` – custom domain for GitHub Pages.
- No server or compiled code; content is purely Markdown.

##### Extract insights from the README
- Purpose: guide for free self-taught Data Science education.
- Workflow: fork → tick checkboxes → use Issues/PRs for contributions.
- Deployment: likely via GitHub Pages (served from `master`/`gh-pages` branch).

##### Main components
a. **Content Repository** (GitHub)
- Stores all Markdown files, workflows, license, domain config.
b. **Continuous Integration / Automation**
- GitHub Actions flow: e.g. `delete-empty-issues.yml` to auto-clean stale issues.
c. **Hosting Layer**
- GitHub Pages (Jekyll or default static site) + custom domain (CNAME).
d. **Users**
- **Students/Readers**: browse curriculum site, view course pages.
- **Contributors/Maintainers**: fork, open issues, submit PRs, merge changes.
e. **GitHub Issues & Pull Requests**
- Feedback loop and content updates.

##### Relationships & interactions
- Students/Readers → HTTP GET → Hosted site (GitHub Pages) ← GitHub Repo
- Contributors ↔ GitHub Repo via fork, pull requests, issues
- PR merge → triggers CI workflows → automatic housekeeping (deleting empty issues)
- Merge → GitHub Pages rebuild & deploy → updated static site

##### Architectural patterns/design principles
- **Content-as-Code**: all curriculum content lives in version control.
- **GitHub Flow**: fork → PR → CI checks → merge → deploy.
- **Static Site Delivery**: low-overhead hosting, fast page loads.
- **Modular Content**: each course in its own folder; extras centralized.

##### Relevant technologies/frameworks/libraries
- GitHub, GitHub Actions, GitHub Pages (Jekyll under the hood)
- Markdown for content authoring
- Custom domain (CNAME)

##### Detail
- Workflow triggers: “on PR merge → rebuild”.
- Custom domain resolution: CNAME → GitHub Pages endpoint.
- Automatic issue-cleanup action.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Layer
    Student["Student/Reader"]:::user
    Contributor["Contributor/Maintainer"]:::user

    %% Version Control & CI
    subgraph "Version Control & CI"
        Repo["GitHub Repo"]:::repo

        subgraph "Content Repository"
            CoursePages["coursepages/"]:::repo
            IntroCS["intro-cs/README.md"]:::repo
            IntroProg["intro-programming/README.md"]:::repo
            Extras["extras/"]:::repo
            Books["extras/books.md"]:::repo
            Courses["extras/courses.md"]:::repo
            Specials["extras/specializations.md"]:::repo
            Readme["README.md"]:::repo
            License["LICENSE.md"]:::repo
            CNAMEFile["CNAME"]:::repo
        end

        subgraph "CI & Automation"
            DeleteEmpty["delete-empty-issues.yml"]:::ci
            IssueTemplate["request-for-comment-template.md"]:::ci
        end
    end

    %% Hosting Layer
    subgraph "Hosting Layer"
        Pages["GitHub Pages"]:::hosting
        Domain["Custom Domain (CNAME)"]:::hosting
    end

    %% Relationships
    Student -->|"HTTP GET"| Pages
    Domain -->|"resolves to"| Pages
    Repo -->|"hosts content"| Pages
    Contributor -->|"fork & PR"| Repo
    Repo -->|"on PR merge triggers"| DeleteEmpty
    DeleteEmpty -->|"cleanup issues"| Repo
    Repo -->|"on PR merge triggers rebuild"| Pages

    %% Click Events
    click CoursePages "https://github.com/ossu/data-science/tree/master/coursepages/"
    click IntroCS "https://github.com/ossu/data-science/blob/master/coursepages/intro-cs/README.md"
    click IntroProg "https://github.com/ossu/data-science/blob/master/coursepages/intro-programming/README.md"
    click Extras "https://github.com/ossu/data-science/tree/master/extras/"
    click Books "https://github.com/ossu/data-science/blob/master/extras/books.md"
    click Courses "https://github.com/ossu/data-science/blob/master/extras/courses.md"
    click Specials "https://github.com/ossu/data-science/blob/master/extras/specializations.md"
    click Readme "https://github.com/ossu/data-science/blob/master/README.md"
    click License "https://github.com/ossu/data-science/blob/master/LICENSE.md"
    click CNAMEFile "https://github.com/ossu/data-science/tree/master/CNAME"
    click DeleteEmpty "https://github.com/ossu/data-science/blob/master/.github/workflows/delete-empty-issues.yml"
    click IssueTemplate "https://github.com/ossu/data-science/blob/master/.github/ISSUE_TEMPLATE/request-for-comment-template.md"

    %% Styles
    classDef user fill:#FFE082,stroke:#E65100,color:#000;
    classDef repo fill:#BBDEFB,stroke:#1976D2,color:#000;
    classDef ci fill:#C8E6C9,stroke:#388E3C,color:#000;
    classDef hosting fill:#FFE0B2,stroke:#FB8C00,color:#000;
```
