# ctp-eos/ctp-sci-courses architecture

> Architecture diagram of the GitHub repository ctp-eos/ctp-sci-courses, 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/ctp-eos/ctp-sci-courses
- Repository: https://github.com/ctp-eos/ctp-sci-courses

## Overview

##### Project type and purpose
- This is not a traditional “frontend‐backend” codebase but a content repository of Markdown course modules (CTPSci Courses Syllabus).
- Its purpose is to hold, version, and publish a structured series of educational materials on “CTP Energy Science.”

##### File structure
- Top‐level directories “01…08” each contain a single Markdown file, one per course module.
- README.md describes the overall syllabus, phase I & phase II courses, and project background.
- “Recommended Folder Structure.md” suggests how future content should be organized.
- No code or configuration files are present, implying that a separate build/publishing system (e.g., a static site generator or documentation platform) sits outside this repo or is planned.

##### README for additional insights
- Course modules are linearly numbered and grouped by phases.
- Future expansion is expected, with placeholders for additional courses and a curriculum framework.
- Collaboration is via GitHub (implied by markdown links).

a. Content Repository
– GitHub (or equivalent) storing markdown modules, README, folder‐structure guidelines.
b. Editorial Workflow / CI Pipeline
– System (GitHub Actions, Travis CI, etc.) that lints markdown, enforces folder conventions, and triggers builds.
c. Static Site Generator (SSG) / Documentation Platform
– e.g., Jekyll, Hugo, Docusaurus, MkDocs—transforms markdown into HTML.
d. Hosting / CDN
– e.g., GitHub Pages, Netlify, Vercel, AWS S3 + CloudFront serving the generated site.
e. End‐Users / Learners
– Web browsers or mobile devices accessing published content.
f. Administrators / Course Maintainers
– Editors or maintainers who push updates to the repo via pull requests.
g. Future Integration Points (optional)
– Forum platform (Matrix, Zoom links), Event scheduling service, Credentialing/LMS integration.

##### Relationships & Data Flows
– Authors push commits → Content Repository
– CI Pipeline runs on push → Markdown validation & build triggers
– Build job invokes SSG → Generates static site artifacts
– Artifacts deploy to Hosting/CDN → Publicly accessible site
– End‐Users request pages from CDN → Site content delivered

##### Architectural patterns & principles
– Separation of concerns: content (Markdown) vs. presentation (SSG templates) vs. infrastructure (hosting).
– GitOps / Infrastructure as Code: repository drives the entire publishing workflow.
– Extensibility: new course modules simply follow “NN-Title/Title.md” pattern for automatic inclusion.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    Authors["Authors / Course Maintainers"]:::users
    Users["End-Users / Learners"]:::users

    %% Content Repository
    subgraph "Content Repository"
        direction TB
        Repo["Markdown Course Modules"]:::content
        README["README.md"]:::content
        Guide["Recommended Folder Structure.md"]:::content
        M1["01: The Basics of CTP Energy Science"]:::content
        M2["02: The New Science of Our Non-physical C-Existence"]:::content
        M3["03: The New Science of the Creation of Events & Conditions"]:::content
        M4["04: The New Science of Our Thought & Thinking"]:::content
        M5["05: The New Science of Our Dreams"]:::content
        M6["06: The New Science of Species & Civilizations"]:::content
        M7["07: The New Science of the Paranormal"]:::content
        M8["08: The New Science of Higher Self & Aspects"]:::content
    end

    %% Build & Deployment
    CI["CI Pipeline (Lint & Build)"]:::build
    SSG["Static Site Generator"]:::build

    %% Hosting & Delivery
    Hosting["Hosting / CDN"]:::serve

    %% Future Integrations
    subgraph "Future Integrations"
        direction TB
        Forum["Forum Platform"]:::future
        LMS["LMS / Credentialing Service"]:::future
    end

    %% Relationships
    Authors -->|git push / pull request| Repo
    Repo -->|on push triggers| CI
    Guide -.->|provides conventions| CI
    CI -->|build site| SSG
    SSG -->|deploy artifacts| Hosting
    Hosting -->|HTTP GET| Users

    %% Click Events
    click Repo "https://github.com/ctp-eos/ctp-sci-courses/tree/main//"
    click README "https://github.com/ctp-eos/ctp-sci-courses/blob/main/README.md"
    click Guide "https://github.com/ctp-eos/ctp-sci-courses/blob/main/Recommended Folder Structure.md"
    click M1 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/01: The Basics of CTP Energy Science (CTPSci)/The Basics of CTP Energy Science (CTPSci).md"
    click M2 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/02: The New Science of Our Non-physical C-Existence/The New Science of Our Non-physical C-Existence.md"
    click M3 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/03: The New Science of the Creation of Events & Conditions/The New Science of the Creation of Events & Conditions.md"
    click M4 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/04: The New Science of Our Thought & Thinking/The New Science of Our Thought & Thinking.md"
    click M5 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/05: The New Science of Our Dreams/The New Science of Our Dreams.md"
    click M6 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/06: The New Science of Species & Civilizations/The New Science of Species & Civilizations.md"
    click M7 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/07: The New Science of the Paranormal/07: The New Science of the Paranormal.md"
    click M8 "https://github.com/ctp-eos/ctp-sci-courses/blob/main/08: The New Science of Higher Self & Aspects/The New Science of Higher Self & Aspects.md"

    %% Styles
    classDef content fill:#DCEEFB,stroke:#0366d6,color:#0366d6
    classDef build fill:#D1FADF,stroke:#15803d,color:#15803d
    classDef serve fill:#FFEDD5,stroke:#c2410c,color:#c2410c
    classDef users fill:#FFE4E6,stroke:#be123c,color:#be123c
    classDef future fill:#F0F0F0,stroke:#6b7280,color:#6b7280,stroke-dasharray: 5 5
```
