# cyfrin/foundry-full-course-cu architecture

> Architecture diagram of the GitHub repository cyfrin/foundry-full-course-cu, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cyfrin/foundry-full-course-cu
- Repository: https://github.com/cyfrin/foundry-full-course-cu

## Overview

##### Project type and purpose
- This is a documentation‐first, open-source course repository. It contains Markdown lesson files, update logs, media assets (thumbnails), GitHub governance (issue templates, contribution guides), and links out to the Cyfrin Updraft platform. Its primary role is to serve as a single source of truth for course content and to drive an external course website.

##### File-structure analysis
- Top-level directories
- .github/ – issue/PR templates & images for GitHub
- ai-prompting-f23/ – a sub-course’s lesson content in Markdown
- thumbnails/ – static image assets
- Top-level files
- README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE – repo governance & overview
- *.md (chronological-updates.md, cookbook-listings.md, etc.) – supplemental guides
- No src/, lib/, or code modules; this is purely content plus repository metadata.

##### Key insights from README
- The README enumerates 150+ sections across multiple courses (Solidity 101, Foundry Fundamentals, Advanced Foundry, etc.)
- External integrations:
- Updraft course host (updraft.cyfrin.io)
- GitHub Discussions for Q&A
- Social/Newsletter/Discord links
- Testnet faucets, Chainlink, ZKsync, etc., as learning tools

a. Content authors (instructors, contributors)
b. GitHub repository (Markdown content + metadata + media assets)
c. CI/CD or manual publishing process (e.g., GitHub Actions, scripts, or Updraft import)
d. External Course Platform (Cyfrin Updraft)
e. Learners (end users visiting updraft.cyfrin.io)
f. Community & support channels (GitHub Issues, GitHub Discussions, Discord, social media links)

##### Relationships and interactions
- Authors → (git push) → GitHub repo
- GitHub repo → (CI/CD or manual export) → Updraft platform
- Learners ↔ Updraft platform (consume lessons, view videos, follow links)
- Learners ↔ Community channels (post questions, discuss, report issues)
- GitHub repo ↔ GitHub Issues/Discussions (issue templates feed issue creation; CONTRIBUTING guide governs PRs)

##### Architectural patterns & design principles
- Content-as-code: all lessons and configuration live in Git
- Single source of truth: Markdown files feed both GitHub site and external LMS
- Separation of concerns: docs (Markdown) vs. platform (Updraft) vs. community (Discord/Discussions)

##### Technologies & frameworks
- Markdown & Git for content management
- GitHub for version control, issue tracking, templates, and community
- Cyfrin Updraft (proprietary LMS) for content hosting and video delivery
- External services: Chainlink, ZKsync, faucets as course references

##### Detail level
- Every critical element: content authors, repository, CI/CD, LMS, support channels
- Don’t clutter with minor links; group similar external services together (e.g., “faucets & testnets”)
- Keep it high-level but show the flow of content and feedback loops

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Actors
    Authors["Content Authors"]:::user

    %% Source & Governance
    subgraph "Source & Governance"
        Repo[(GitHub Repo)]:::source
        README["README.md"]:::source
        CONTR["CONTRIBUTING.md"]:::source
        COC["CODE_OF_CONDUCT.md"]:::source
        LIC["LICENSE"]:::source
        GitMeta[".github"]:::source
        MDStore["Markdown Store"]:::source
        SubCourse["ai-prompting-f23"]:::source
        Thumbs["thumbnails"]:::source
        Supp["Supplemental Guides"]:::source
    end

    %% Platform
    Updraft["Updraft Platform"]:::platform

    %% Users & Community
    Learners["Learners"]:::user
    subgraph "Community & Support"
        Issues["GitHub Issues/PRs"]:::user
        Discussions["GitHub Discussions"]:::user
        Discord["Discord & Social"]:::user
    end

    %% Flows
    Authors -->|"git push"| Repo
    Repo --> MDStore
    Repo --> README
    Repo --> CONTR
    Repo --> COC
    Repo --> LIC
    Repo --> GitMeta
    Repo --> SubCourse
    Repo --> Thumbs
    Repo --> Supp

    Repo -->|"publish pipeline"| Updraft
    Learners -->|consume| Updraft
    Updraft -->|content delivery| Learners

    Learners -->|ask questions| Discussions
    Learners -->|report issues| Issues
    Discussions -->|feedback| Repo
    Issues -->|PRs & issues| Repo

    %% Click Events
    click Repo "https://github.com/cyfrin/foundry-full-course-cu/tree/main//"
    click README "https://github.com/cyfrin/foundry-full-course-cu/blob/main//README.md"
    click CONTR "https://github.com/cyfrin/foundry-full-course-cu/blob/main//CONTRIBUTING.md"
    click COC "https://github.com/cyfrin/foundry-full-course-cu/blob/main//CODE_OF_CONDUCT.md"
    click LIC "https://github.com/cyfrin/foundry-full-course-cu/tree/main//LICENSE"
    click GitMeta "https://github.com/cyfrin/foundry-full-course-cu/blob/main//.github"
    click SubCourse "https://github.com/cyfrin/foundry-full-course-cu/tree/main//ai-prompting-f23/"
    click Thumbs "https://github.com/cyfrin/foundry-full-course-cu/tree/main//thumbnails"

    %% Classes
    classDef source fill:#D8BFD8,stroke:#800080,color:#000;
    classDef platform fill:#ADD8E6,stroke:#0000FF,color:#000;
    classDef user fill:#90EE90,stroke:#008000,color:#000;
```
