diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index f47c065..e60d5aa 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -901,21 +901,23 @@ volumes: ### CI / CD -The `.gitea/workflows/` directory contains three pipeline definitions: +The `.gitea/workflows/` directory contains five pipeline definitions: | File | Trigger | Purpose | |------|---------|--------| -| `ci.yml` | Every push / PR | Security audit (`npm audit --audit-level=high`) + tests with V8 coverage | -| `build-image.yml` | Push to `main` / `develop` | Build and push Docker image to `docker.i3omb.com` | -| `create-release.yml` | Tag push (`v*`) | Create a Gitea release | +| `ci.yml` | Every push / PR (all branches) | Security audit (`npm audit --audit-level=high`) + tests with V8 coverage | +| `build-image.yml` | Push to `release/**` or `develop` | Build and push Docker image to `reg.i3omb.com`. `release/**` pushes versioned + `latest` tags; `develop` pushes a `:develop` tag. | +| `create-release.yml` | Tag push (`v*`) | Generate release notes from git log and create a Gitea release | +| `docs-check.yml` | Push / PR touching `**.md` (non-main / non-release branches) | Markdown lint + Mermaid diagram parse validation | +| `licence-check.yml` | Push / PR touching `package.json` or `package-lock.json` | Verify all production dependency licences are compatible with MIT | -> **Diagrams** are written in Mermaid and render natively in Gitea — no CI workflow required. See [Section 13](#13-diagrams). +> **Diagrams** are written in Mermaid and render natively in Gitea — no separate diagram files or CI render step required. See [Section 13](#13-diagrams). --- ## 13. Diagrams -All diagrams are written in [Mermaid](https://mermaid.js.org/) and render natively in Gitea and GitHub markdown. +All diagrams are written in [Mermaid](https://mermaid.js.org/) and render natively in Gitea and GitHub markdown. No external tooling or PNG exports are required — the source is the diagram. ### 13.1 Component Diagram @@ -1302,6 +1304,13 @@ classDiagram +availability string +hash string +completedAt string + +canBlocklist boolean + +addedOn number + +arrQueueId number + +arrType string + +arrInstanceUrl string + +arrContentId number + +arrContentType string } class TagBadge { +label string @@ -1346,6 +1355,7 @@ classDiagram +num_seeds number +num_leechs number +availability number + +added_on number } class SonarrQueueRecord { +seriesId number diff --git a/docs/diagrams/activity-matching.png b/docs/diagrams/activity-matching.png deleted file mode 100644 index d3d5ef7..0000000 Binary files a/docs/diagrams/activity-matching.png and /dev/null differ diff --git a/docs/diagrams/class-data.png b/docs/diagrams/class-data.png deleted file mode 100644 index 84b04da..0000000 Binary files a/docs/diagrams/class-data.png and /dev/null differ diff --git a/docs/diagrams/class-server.png b/docs/diagrams/class-server.png deleted file mode 100644 index a73523d..0000000 Binary files a/docs/diagrams/class-server.png and /dev/null differ diff --git a/docs/diagrams/component.png b/docs/diagrams/component.png deleted file mode 100644 index 41ee079..0000000 Binary files a/docs/diagrams/component.png and /dev/null differ diff --git a/docs/diagrams/seq-auth.png b/docs/diagrams/seq-auth.png deleted file mode 100644 index fb89f06..0000000 Binary files a/docs/diagrams/seq-auth.png and /dev/null differ diff --git a/docs/diagrams/seq-dashboard.png b/docs/diagrams/seq-dashboard.png deleted file mode 100644 index 19f0745..0000000 Binary files a/docs/diagrams/seq-dashboard.png and /dev/null differ diff --git a/docs/diagrams/seq-polling.png b/docs/diagrams/seq-polling.png deleted file mode 100644 index ba4a7e9..0000000 Binary files a/docs/diagrams/seq-polling.png and /dev/null differ diff --git a/docs/diagrams/state-poller.png b/docs/diagrams/state-poller.png deleted file mode 100644 index be30954..0000000 Binary files a/docs/diagrams/state-poller.png and /dev/null differ diff --git a/docs/diagrams/state-ui.png b/docs/diagrams/state-ui.png deleted file mode 100644 index 1442d70..0000000 Binary files a/docs/diagrams/state-ui.png and /dev/null differ