# megharajmekap/handbook architecture

> Architecture diagram of the GitHub repository megharajmekap/handbook, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/megharajmekap/handbook
- Repository: https://github.com/megharajmekap/handbook

## Overview

This repository is a class-recordings and notes site, with companion tools for adding and checking recording entries. The main visitor workflow is to browse the recordings in the site and follow a recording link; the README identifies recordings and notes as the product content. A separate maintenance workflow adds entries to the recordings array and validates its metadata, thumbnails, and links. The sampled sources do not show how the HTML pages render or how notes are presented, so those internal relationships are not inferred.

Main entry points: [`index.html`](https://github.com/megharajmekap/handbook/blob/main/index.html) (Recording entries), [`scripts/validate-data.mjs`](https://github.com/megharajmekap/handbook/blob/main/scripts/validate-data.mjs) (Data validator), [`scripts/add-recording.mjs`](https://github.com/megharajmekap/handbook/blob/main/scripts/add-recording.mjs) (Add recording CLI), [`FRA_Notes`](https://github.com/megharajmekap/handbook/tree/main/FRA_Notes) (Course notes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_site["Learning site"]
  node_site["Recordings site<br/>[index.html]"]
end

subgraph group_content["Course content"]
  node_recordings["Recording entries<br/>[index.html]"]
  node_notes["Course notes"]
  node_thumbnails["Thumbnail files"]
end

subgraph group_maintenance["Recording maintenance"]
  node_add_cli["Add recording CLI<br/>[add-recording.mjs]"]
  node_validator["Data validator<br/>[validate-data.mjs]"]
end

subgraph group_browser["Browser support"]
  node_service_worker["Service worker<br/>[sw.js]"]
end

node_visitor(("Learner"))
node_recording_host["Recording hosts"]
node_editor(("Content maintainer"))
node_browser(("Browser"))

node_visitor -->|"opens"| node_site
node_site -.->|"lists"| node_recordings
node_recordings -->|"links to"| node_recording_host
node_visitor -.->|"accesses"| node_notes
node_editor -->|"enters details"| node_add_cli
node_add_cli -->|"appends entry"| node_recordings
node_validator -->|"reads entries"| node_recordings
node_validator -->|"checks files"| node_thumbnails
node_validator -->|"checks links"| node_recording_host
node_browser -.->|"activates"| node_service_worker

click node_site "https://github.com/megharajmekap/handbook/blob/main/index.html"
click node_recordings "https://github.com/megharajmekap/handbook/blob/main/index.html"
click node_notes "https://github.com/megharajmekap/handbook/tree/main/FRA_Notes"
click node_add_cli "https://github.com/megharajmekap/handbook/blob/main/scripts/add-recording.mjs"
click node_validator "https://github.com/megharajmekap/handbook/blob/main/scripts/validate-data.mjs"
click node_thumbnails "https://github.com/megharajmekap/handbook/tree/main/thumbnails"
click node_service_worker "https://github.com/megharajmekap/handbook/blob/main/sw.js"

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_site,node_browser toneBlue
class node_recordings,node_notes,node_thumbnails toneAmber
class node_add_cli,node_validator toneMint
class node_service_worker toneRose
class node_visitor,node_recording_host,node_editor toneIndigo
```

## Components

### Learning site

- [Recordings site](https://github.com/megharajmekap/handbook/blob/main/index.html): `index.html`

### Course content

- [Recording entries](https://github.com/megharajmekap/handbook/blob/main/index.html): `index.html`
- [Course notes](https://github.com/megharajmekap/handbook/tree/main/FRA_Notes): `FRA_Notes`
- [Thumbnail files](https://github.com/megharajmekap/handbook/tree/main/thumbnails): `thumbnails`

### Recording maintenance

- [Add recording CLI](https://github.com/megharajmekap/handbook/blob/main/scripts/add-recording.mjs): `scripts/add-recording.mjs`
- [Data validator](https://github.com/megharajmekap/handbook/blob/main/scripts/validate-data.mjs): `scripts/validate-data.mjs`

### Browser support

- [Service worker](https://github.com/megharajmekap/handbook/blob/main/sw.js): `sw.js`

### Other components

- **Learner**
- **Recording hosts**
- **Content maintainer**
- **Browser**

## Connections

- Learner → Recordings site: opens (evidence: `README.md`)
- Recordings site → Recording entries: lists
- Recording entries → Recording hosts: links to (evidence: `README.md`)
- Learner → Course notes: accesses
- Content maintainer → Add recording CLI: enters details (evidence: `README.md`)
- Add recording CLI → Recording entries: appends entry (evidence: `scripts/add-recording.mjs`)
- Data validator → Recording entries: reads entries (evidence: `scripts/validate-data.mjs`)
- Data validator → Thumbnail files: checks files (evidence: `scripts/validate-data.mjs`)
- Data validator → Recording hosts: checks links (evidence: `scripts/validate-data.mjs`)
- Browser → Service worker: activates
