How ethereum/zket-core-program works
Project type and purpose
• This is a documentation-as-code repository implementing a self-learning cryptography curriculum (“Core Program”), organized by year (2023, 2024, 2025).
• Purpose: store and version curriculum materials in Markdown, host them (e.g., via GitHub Pages), and manage contributions via GitHub (issues & pull requests).
File structure
• Top-level items:
• .github/ (issue + PR templates)
• .gitignore
• 2023/ (modules + answers)
• 2024/ (assets, contributions, weekly course docs, FAQs)
• 2025/ (future curriculum)
• README.md (project overview & contribution guide)
• No application code—this is a static-content repo.
• Contribution flow is embedded via .github templates.
README for additional insights
• Describes the curriculum, its organization by year, and how to contribute.
• No explicit build or deployment instructions, but implies publishing to an open platform (e.g., GitHub Pages).
Components
a. Content layer
• Markdown documents under folders 2023/, 2024/, 2025/
b. Version control & collaboration
• GitHub repository
• Issue tracker (uses .github/ISSUE_TEMPLATE)
• Pull request workflow (uses .github/pull_request_template.md)
c. Continuous integration / delivery (optional but recommended)
• GitHub Actions (validate Markdown, link checks, spellcheck)
• Static site generator (Jekyll/Hugo/Gatsby) that transforms Markdown → HTML
d. Hosting / serving
• GitHub Pages (or other static-site hosting) serving the generated site
e. Users & contributors
• Students/readers browsing the curriculum
• Contributors submitting issues & PRs
Relationships and interactions
• Contributors fork/branch → commit Markdown changes → open PR
→ GitHub Actions run checks → PR merged into main
→ triggers site build via Actions
→ deployment to GitHub Pages
• End users browse the hosted curriculum site via a web browser.
• When an error or suggestion arises, a user opens an issue → triggers notification to maintainers.
Architectural patterns & design principles
• Documentation-as-Code: treat content same as source code
• GitOps / CI-driven publishing
• Clear separation:
• Content (repo folders)
• Process (CI workflow, issue/PR templates)
• Delivery (static site hosting)
Technologies, frameworks, or libraries
• Markdown (content format)
• Git & GitHub (VCS + collaboration)
• GitHub Actions (CI/CD)
• Static Site Generator (Jekyll, Hugo, or Gatsby)
• GitHub Pages (hosting)