# soft-eng-practicum/softdev2-resources architecture

> Architecture diagram of the GitHub repository soft-eng-practicum/softdev2-resources, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/soft-eng-practicum/softdev2-resources
- Repository: https://github.com/soft-eng-practicum/softdev2-resources

## Overview

This repository is an Agile software-development course textbook and teaching-resource site. Instructors and students use its course materials, which Hugo renders as documentation-style chapters and online presentations; the published static site is then hosted for browser access. The README documents the roles of the themes and custom presentation shortcodes. Source excerpts were unavailable, so relationships below are limited to those described in the README; content branches are represented at their tree-supported directory paths.

Main entry points: [`content`](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content) (Class presentations), [`content/student`](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/student) (Student textbook), [`layouts/shortcodes`](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/layouts/shortcodes) (Presentation shortcodes), [`config.toml`](https://github.com/soft-eng-practicum/softdev2-resources/blob/master/config.toml) (Course configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_audiences["Course audiences"]
  node_instructor(("Instructor"))
  node_student(("Student"))
end

subgraph group_materials["Course materials"]
  node_student_text["Student textbook"]
  node_instructor_prep["Instructor preparation"]
  node_assignments["Assignments"]
  node_exams["Take-home exams"]
  node_workshops["Workshops"]
  node_presentations["Class presentations"]
end

subgraph group_site["Site presentation"]
  node_site_config["Course configuration<br/>[config.toml]"]
  node_custom_shortcodes["Presentation shortcodes"]
  node_techdoc["Techdoc theme"]
  node_reveal_theme["Reveal Hugo theme"]
end

subgraph group_publishing["Published site"]
  node_static_site["Published static site"]
  node_static_host["Static host"]
end

node_hugo["Hugo renderer"]

node_instructor -->|"uses"| node_instructor_prep
node_instructor -->|"uses"| node_assignments
node_instructor -->|"uses"| node_exams
node_student -->|"uses"| node_student_text
node_student -->|"views"| node_presentations
node_instructor -->|"customizes"| node_presentations
node_student -.->|"uses"| node_workshops
node_presentations -->|"uses"| node_custom_shortcodes
node_site_config -->|"configures"| node_custom_shortcodes
node_student_text -->|"rendered by"| node_hugo
node_presentations -->|"rendered by"| node_hugo
node_techdoc -->|"provides browsing"| node_hugo
node_reveal_theme -->|"provides slides"| node_hugo
node_hugo -->|"generates"| node_static_site
node_static_site -->|"hosted on"| node_static_host
node_student -->|"accesses"| node_static_site

click node_student_text "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/student"
click node_instructor_prep "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor"
click node_assignments "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor/assignments"
click node_exams "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor/exams"
click node_workshops "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/workshops"
click node_presentations "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content"
click node_site_config "https://github.com/soft-eng-practicum/softdev2-resources/blob/master/config.toml"
click node_custom_shortcodes "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/layouts/shortcodes"
click node_techdoc "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/themes/techdoc"
click node_reveal_theme "https://github.com/soft-eng-practicum/softdev2-resources/tree/master/themes/reveal-hugo"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_instructor,node_student toneBlue
class node_student_text,node_instructor_prep,node_assignments,node_exams,node_workshops,node_presentations toneAmber
class node_site_config,node_custom_shortcodes,node_techdoc,node_reveal_theme toneMint
class node_static_site,node_static_host toneRose
class node_hugo toneIndigo
```

## Components

### Course audiences

- **Instructor**
- **Student**

### Course materials

- [Student textbook](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/student): `content/student`
- [Instructor preparation](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor): `content/instructor`
- [Assignments](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor/assignments): `content/instructor/assignments`
- [Take-home exams](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/instructor/exams): `content/instructor/exams`
- [Workshops](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content/workshops): `content/workshops`
- [Class presentations](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/content): `content`

### Site presentation

- [Course configuration](https://github.com/soft-eng-practicum/softdev2-resources/blob/master/config.toml): `config.toml`
- [Presentation shortcodes](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/layouts/shortcodes): `layouts/shortcodes`
- [Techdoc theme](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/themes/techdoc): `themes/techdoc`
- [Reveal Hugo theme](https://github.com/soft-eng-practicum/softdev2-resources/tree/master/themes/reveal-hugo): `themes/reveal-hugo`

### Published site

- **Published static site**
- **Static host**

### Other components

- **Hugo renderer**

## Connections

- Instructor → Instructor preparation: uses (evidence: `README.md`)
- Instructor → Assignments: uses (evidence: `README.md`)
- Instructor → Take-home exams: uses (evidence: `README.md`)
- Student → Student textbook: uses (evidence: `README.md`)
- Student → Class presentations: views (evidence: `README.md`)
- Instructor → Class presentations: customizes (evidence: `README.md`)
- Student → Workshops: uses
- Class presentations → Presentation shortcodes: uses (evidence: `README.md`)
- Course configuration → Presentation shortcodes: configures (evidence: `README.md`)
- Student textbook → Hugo renderer: rendered by (evidence: `README.md`)
- Class presentations → Hugo renderer: rendered by (evidence: `README.md`)
- Techdoc theme → Hugo renderer: provides browsing (evidence: `README.md`)
- Reveal Hugo theme → Hugo renderer: provides slides (evidence: `README.md`)
- Hugo renderer → Published static site: generates (evidence: `README.md`)
- Published static site → Static host: hosted on (evidence: `README.md`)
- Student → Published static site: accesses (evidence: `README.md`)
