From 8d59f09cb26acc01c92b9b139f5dc035e3381b43 Mon Sep 17 00:00:00 2001 From: Aaron Po Date: Wed, 2 Sep 2026 21:28:23 -0400 Subject: [PATCH] chore/update layouts in diagrams (#273) --- docs/pipeline/diagrams/current/activity.mmd | 6 +++++- docs/pipeline/diagrams/current/class.mmd | 5 +++++ docs/pipeline/diagrams/planned/activity.mmd | 7 ++++++- docs/pipeline/diagrams/planned/class.mmd | 4 ++++ docs/web/diagrams/database-schema/beer.mmd | 5 +++++ docs/web/diagrams/database-schema/brewery.mmd | 8 +++++++- docs/web/diagrams/database-schema/identity.mmd | 5 +++++ docs/web/diagrams/database-schema/location.mmd | 6 +++--- docs/web/diagrams/database-schema/media.mmd | 5 +++++ docs/web/diagrams/vertical-slice/host-wiring.mmd | 4 +--- docs/web/diagrams/vertical-slice/project-references.mmd | 3 +-- 11 files changed, 47 insertions(+), 11 deletions(-) diff --git a/docs/pipeline/diagrams/current/activity.mmd b/docs/pipeline/diagrams/current/activity.mmd index d98403bc..f5a78bf2 100644 --- a/docs/pipeline/diagrams/current/activity.mmd +++ b/docs/pipeline/diagrams/current/activity.mmd @@ -1,4 +1,8 @@ -flowchart TD +--- +config: + layout: elk +--- +flowchart LR Start([start]) --> ParseArgs["main.cc: ParseArguments(argc, argv)"] ParseArgs --> ArgsValid{Arguments valid?} ArgsValid -- no --> LogErr[Log error / usage info] --> Stop1([stop]) diff --git a/docs/pipeline/diagrams/current/class.mmd b/docs/pipeline/diagrams/current/class.mmd index cee4ed4d..dbe4db71 100644 --- a/docs/pipeline/diagrams/current/class.mmd +++ b/docs/pipeline/diagrams/current/class.mmd @@ -1,3 +1,8 @@ +--- +config: + layout: elk +--- + classDiagram class BiergartenPipelineOrchestrator { -shared_ptr~ILogger~ logger_ diff --git a/docs/pipeline/diagrams/planned/activity.mmd b/docs/pipeline/diagrams/planned/activity.mmd index e19b76eb..f468b857 100644 --- a/docs/pipeline/diagrams/planned/activity.mmd +++ b/docs/pipeline/diagrams/planned/activity.mmd @@ -1,4 +1,9 @@ -flowchart TD +--- +config: + layout: elk +--- + +flowchart LR Start([start]) --> ParseArgs["Main: ParseArguments(argc, argv)"] ParseArgs --> InvalidArgs{Invalid args?} InvalidArgs -- yes --> LogErr["spdlog::error"] --> Stop1([stop]) diff --git a/docs/pipeline/diagrams/planned/class.mmd b/docs/pipeline/diagrams/planned/class.mmd index 3fb645ef..a94300fa 100644 --- a/docs/pipeline/diagrams/planned/class.mmd +++ b/docs/pipeline/diagrams/planned/class.mmd @@ -1,3 +1,7 @@ +--- +config: + layout: elk +--- classDiagram namespace DomainModels { class Location { diff --git a/docs/web/diagrams/database-schema/beer.mmd b/docs/web/diagrams/database-schema/beer.mmd index f0e7b387..3d02995f 100644 --- a/docs/web/diagrams/database-schema/beer.mmd +++ b/docs/web/diagrams/database-schema/beer.mmd @@ -1,3 +1,8 @@ +--- +config: + layout: elk +--- + erDiagram BeerStyle ||--o{ Beer : "categorizes" Beer ||--o{ BeerPhoto : "has photos" diff --git a/docs/web/diagrams/database-schema/brewery.mmd b/docs/web/diagrams/database-schema/brewery.mmd index 1b831d0b..f5346cbe 100644 --- a/docs/web/diagrams/database-schema/brewery.mmd +++ b/docs/web/diagrams/database-schema/brewery.mmd @@ -1,5 +1,11 @@ +--- +config: + layout: elk +--- + + erDiagram - Brewery ||--o| BreweryLoc : "has location" + Brewery ||--o| BreweryLocation : "has location" Brewery ||--o{ BreweryPhoto : "has photos" Brewery ||--o{ Beer : "brews" diff --git a/docs/web/diagrams/database-schema/identity.mmd b/docs/web/diagrams/database-schema/identity.mmd index 38395a92..f3d913e9 100644 --- a/docs/web/diagrams/database-schema/identity.mmd +++ b/docs/web/diagrams/database-schema/identity.mmd @@ -1,3 +1,8 @@ +--- +config: + layout: elk +--- + erDiagram User ||--o{ Cred : "has credentials" User ||--o| Verify : "has verification" diff --git a/docs/web/diagrams/database-schema/location.mmd b/docs/web/diagrams/database-schema/location.mmd index 4840a233..5b9bd022 100644 --- a/docs/web/diagrams/database-schema/location.mmd +++ b/docs/web/diagrams/database-schema/location.mmd @@ -1,10 +1,10 @@ erDiagram Country ||--o{ StateProvince : "has" StateProvince ||--o{ City : "has" - City ||--o{ BreweryLoc : "located in" + City ||--o{ BreweryLocation : "located in" %% Cross-schema: defined in full in brewery.mmd - Brewery ||--o| BreweryLoc : "has location" + Brewery ||--o| BreweryLocation : "has location" Country { uniqueidentifier CountryID PK @@ -25,7 +25,7 @@ erDiagram uniqueidentifier StateProvinceID FK } - BreweryLoc { + BreweryLocation { uniqueidentifier BreweryPostLocationID PK uniqueidentifier BreweryPostID "FK, UK" nvarchar AddressLine1 diff --git a/docs/web/diagrams/database-schema/media.mmd b/docs/web/diagrams/database-schema/media.mmd index 4b006716..8e82238a 100644 --- a/docs/web/diagrams/database-schema/media.mmd +++ b/docs/web/diagrams/database-schema/media.mmd @@ -1,3 +1,8 @@ +--- +config: + layout: elk +--- + erDiagram Avatar }o--|| Photo : "uses photo" Photo ||--o{ BreweryPhoto : "used in" diff --git a/docs/web/diagrams/vertical-slice/host-wiring.mmd b/docs/web/diagrams/vertical-slice/host-wiring.mmd index 009d65c7..02d3eb4b 100644 --- a/docs/web/diagrams/vertical-slice/host-wiring.mmd +++ b/docs/web/diagrams/vertical-slice/host-wiring.mmd @@ -1,8 +1,6 @@ --- config: -flowchart: -curve: stepAfter -layout: elk + layout: elk --- flowchart TB diff --git a/docs/web/diagrams/vertical-slice/project-references.mmd b/docs/web/diagrams/vertical-slice/project-references.mmd index d4dc5508..7953bfaa 100644 --- a/docs/web/diagrams/vertical-slice/project-references.mmd +++ b/docs/web/diagrams/vertical-slice/project-references.mmd @@ -1,7 +1,6 @@ --- config: -flowchart: {} -layout: fixed + layout: elk --- flowchart TB