# ethereum/zket-core-program architecture

> Architecture diagram of the GitHub repository ethereum/zket-core-program, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ethereum/zket-core-program
- Repository: https://github.com/ethereum/zket-core-program

## Overview

##### 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)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Users
    Contributor["Contributor"]:::user
    Student["Student/Reader Browser"]:::user

    %% Repository
    Repo["GitHub Repository"]:::system

    %% Content Layer
    subgraph "Content Layer"
        direction TB
        C2023["2023 Curriculum (Markdown)"]:::content
        A2023Ans["2023 Answers (Markdown)"]:::content
        C2024["2024 Curriculum (Markdown)"]:::content
        Assets2024["2024 Assets"]:::content
        ContribGuide["2024 Contributions Guide"]:::content
        Placeholder2025["2025 Curriculum Placeholder"]:::content
    end

    %% Collaboration & VCS
    subgraph "Collaboration & VCS"
        direction TB
        IssueTemp["Issue Templates"]:::collab
        PRTemp["Pull Request Template"]:::collab
        Gitignore[".gitignore"]:::collab
        Readme["README.md"]:::collab
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        direction TB
        Actions["GitHub Actions"]:::ci
        SSG["Static Site Generator"]:::ci
    end

    %% Hosting
    Pages["GitHub Pages (Hosting)"]:::hosting

    %% Relationships
    Contributor -->|fork/branch & commit| Repo
    Contributor -->|open PR| PRTemp
    Student -->|browse site| Pages
    Student -->|open issue| IssueTemp

    C2023 --> Repo
    A2023Ans --> Repo
    C2024 --> Repo
    Assets2024 --> Repo
    ContribGuide --> Repo
    Placeholder2025 --> Repo

    IssueTemp --> Repo
    PRTemp --> Repo
    Gitignore --> Repo
    Readme --> Repo

    Repo -->|on merge trigger CI| Actions
    Actions -->|run checks & build| SSG
    SSG -->|generate static site| Pages
    Pages -->|serve content| Student

    %% Click Events
    click C2023 "https://github.com/ethereum/zket-core-program/tree/main/2023/"
    click A2023Ans "https://github.com/ethereum/zket-core-program/tree/main/2023/answers/"
    click C2024 "https://github.com/ethereum/zket-core-program/tree/main/2024/"
    click Assets2024 "https://github.com/ethereum/zket-core-program/tree/main/2024/assets/"
    click ContribGuide "https://github.com/ethereum/zket-core-program/blob/main/2024/contributions/README.md"
    click Placeholder2025 "https://github.com/ethereum/zket-core-program/blob/main/2025/README.md"
    click IssueTemp "https://github.com/ethereum/zket-core-program/blob/main/.github/ISSUE_TEMPLATE/standard-issue-template-.md"
    click PRTemp "https://github.com/ethereum/zket-core-program/blob/main/.github/pull_request_template.md"
    click Gitignore "https://github.com/ethereum/zket-core-program/blob/main/.gitignore"
    click Readme "https://github.com/ethereum/zket-core-program/blob/main/README.md"

    %% Styles
    classDef content fill:#E0F7FA,stroke:#006064,color:#004D40
    classDef collab fill:#ECEFF1,stroke:#90A4AE,color:#37474F
    classDef ci fill:#E8F5E9,stroke:#388E3C,color:#1B5E20,stroke-dasharray: 5 5
    classDef hosting fill:#FFF8E1,stroke:#F9A825,color:#FF6F00
    classDef system fill:#BBDEFB,stroke:#1976D2,color:#0D47A1
    classDef user fill:#F3E5F5,stroke:#8E24AA,color:#4A148C,stroke-width:2px
```
