How ctp-eos/ctp-sci-courses works
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.