# txt/se25fall architecture

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

- Interactive diagram: https://gitdiagram.com/txt/se25fall
- Repository: https://github.com/txt/se25fall

## Overview

##### Project type and purpose
- This is not a full-stack app or microservice landscape, but a **static documentation site** and course asset repository for “CSC510: Software Engineering.”
- It holds lecture notes, project prompts, reviews, a syllabus, PDF outputs, and shell config snippets—all organized under a Markdown-centric docs folder, built via a Makefile.

##### File structure
- Top-level:
- README.md – landing page with badges, course overview, and links to external resources (Moodle, Google Sheets, Discord, Panopto).
- LICENSE.md, .gitignore – standard repo housekeeping.
- docs/ – contains all Markdown content, subfolders for lectures, projects, reviews, a Makefile, and a generated PDF/ folder.
- sh/ – local shell/dotfile snippets (dotbash.rc, init.lua) used by the instructor or contributors.
- Patterns: single repo holding both **source content** (Markdown) and **build scripts** (docs/Makefile). Output artifacts land under docs/pdf.

##### README for additional insights
- README anchors the system’s purpose: organize weekly lectures, assignment deliverables, and review materials.
- No built-in server code is present—implies a static site generator (or raw Markdown served via GitHub Pages) plus PDF generation via Make/pandoc.

##### Detail
- Every folder of docs (lectures, projects, reviews) as sub-nodes or annotate “docs/lectures,” “docs/projects,” etc., to show content organization.
- Sh/ dotfiles area to indicate developer environment support.
- Don’t over-abstract: show both PDF and HTML branches if both are produced.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Content Repository
    subgraph "Content Repository" 
        MD["docs/"]:::content
        lectures["docs/lectures/"]:::content
        projects["docs/projects/"]:::content
        reviews["docs/reviews/"]:::content
        syllabus["docs/syllabus.md"]:::content
        aidollars["docs/aidollars.md"]:::content
    end

    MD --> lectures
    MD --> projects
    MD --> reviews
    MD --> syllabus
    MD --> aidollars

    %% Local Tools
    subgraph "Local Tools" 
        shdir["sh/"]:::content
        dotbash["dotbash.rc"]:::content
        initlua["init.lua"]:::content
        ell["ell"]:::content
    end

    shdir --> dotbash
    shdir --> initlua
    shdir --> ell

    %% Build System
    subgraph "Build System"
        Makefile["docs/Makefile"]:::build
        Pandoc["Pandoc & Static-Site Generator"]:::build
    end

    MD --> Makefile
    Makefile --> Pandoc

    %% Output Artifacts
    subgraph "Build Outputs"
        PDF["docs/pdf/"]:::output
        HTML["HTML Site"]:::output
    end

    Pandoc --> PDF
    Pandoc --> HTML

    %% Hosting
    GHPages["GitHub Pages"]:::output
    HTML --> GHPages

    %% Repository Files
    README["README.md"]:::content
    LICENSE["LICENSE.md"]:::content
    GITIGNORE[".gitignore"]:::content

    %% External Services
    subgraph "External Services"
        Sheets["Google Sheets"]:::external
        Moodle["Moodle"]:::external
        Discord["Discord"]:::external
        Panopto["Panopto"]:::external
    end

    README --> Sheets
    README --> Moodle
    README --> Discord
    README --> Panopto

    %% Click Events
    click MD "https://github.com/txt/se25fall/tree/main/docs/"
    click lectures "https://github.com/txt/se25fall/tree/main/docs/lectures/"
    click projects "https://github.com/txt/se25fall/tree/main/docs/projects/"
    click reviews "https://github.com/txt/se25fall/tree/main/docs/reviews/"
    click syllabus "https://github.com/txt/se25fall/blob/main/docs/syllabus.md"
    click aidollars "https://github.com/txt/se25fall/blob/main/docs/aidollars.md"
    click Makefile "https://github.com/txt/se25fall/tree/main/docs/Makefile"
    click PDF "https://github.com/txt/se25fall/tree/main/docs/pdf/"
    click README "https://github.com/txt/se25fall/blob/main/README.md"
    click LICENSE "https://github.com/txt/se25fall/blob/main/LICENSE.md"
    click GITIGNORE "https://github.com/txt/se25fall/blob/main/.gitignore"
    click shdir "https://github.com/txt/se25fall/tree/main/sh/"
    click dotbash "https://github.com/txt/se25fall/blob/main/sh/dotbash.rc"
    click initlua "https://github.com/txt/se25fall/blob/main/sh/init.lua"
    click ell "https://github.com/txt/se25fall/tree/main/sh/ell"

    %% Styles
    classDef content fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef build fill:#d4edda,stroke:#333,stroke-width:1px
    classDef output fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef external fill:#ffe5b4,stroke:#333,stroke-width:1px
```
