From 8362a8b11d6e1c31c8766a7d91db02e23b136bd9 Mon Sep 17 00:00:00 2001 From: Stefan Mogeritsch Date: Tue, 13 Jan 2026 14:33:45 +0100 Subject: [PATCH] docs: establish AOM + per-system technical truth (ping-service) --- docs/01_Architecture/ARCHITECTURE.md | 6 +++--- docs/01_Architecture/adr/0000-adr-template-de.md | 2 +- docs/02_Onboarding/Development/start-local.md | 6 +++--- docs/03_Agents/Playbooks/Junie.md | 2 +- docs/06_Infrastructure/Reference/ports-and-urls.md | 13 +++++++------ docs/99_Journal/2026-01.md | 2 +- 6 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/01_Architecture/ARCHITECTURE.md b/docs/01_Architecture/ARCHITECTURE.md index cc9df699..6dff3210 100644 --- a/docs/01_Architecture/ARCHITECTURE.md +++ b/docs/01_Architecture/ARCHITECTURE.md @@ -5,7 +5,7 @@ Dieses Dokument beschreibt die Zielstruktur und das Mapping vom bisherigen Stand Zielstruktur (Top-Level) backend/ Gateway, Discovery (optional), Services - gateway + gateway Spring Cloud Gateway discovery services frontend/ KMP Frontend @@ -71,6 +71,6 @@ Nächste Schritte (MP-22 Folgetasks) 1. Physisches Verschieben der Frontend-Module gemäß Mapping und Anpassung von settings.gradle.kts. 2. Physisches Verschieben der Backend-Komponenten in backend/* inkl. evtl. Package-Pfade, sofern notwendig. 3. Ergänzung von docker-compose.services.yml und docker-compose.clients.yml mit echten Overlays. -4. Erstellen der ersten ADRs unter docs/adr (Koin, SQLDelight, Optimistic Locking, Freshness UI, Core Domain). +4. Erstellen der ersten ADRs unter `docs/01_Architecture/adr/` (Koin, SQLDelight, Optimistic Locking, Freshness UI, Core Domain). -Hinweis: ADRs liegen ab sofort zentral unter `docs/adr/` (nicht mehr unter `docs/architecture/adr/`). C4-Diagramme wurden nach `docs/c4/` verschoben. +Hinweis: ADRs liegen ab sofort zentral unter `docs/01_Architecture/adr/`. C4-Diagramme liegen unter `docs/01_Architecture/c4/`. diff --git a/docs/01_Architecture/adr/0000-adr-template-de.md b/docs/01_Architecture/adr/0000-adr-template-de.md index 1223e3ad..6b323a11 100644 --- a/docs/01_Architecture/adr/0000-adr-template-de.md +++ b/docs/01_Architecture/adr/0000-adr-template-de.md @@ -4,7 +4,7 @@ [Vorgeschlagen | Akzeptiert | Veraltet | Ersetzt] -Falls sie ersetzt, fügen Sie einen Verweis auf die neue ADR ein: `[ADR-XXX](XXX-filename.md)` +Falls sie ersetzt wird, fügen Sie einen Verweis auf die neue ADR ein (Beispiel): `ADR-0012`. ## Kontext diff --git a/docs/02_Onboarding/Development/start-local.md b/docs/02_Onboarding/Development/start-local.md index 2c2d0500..6a03263c 100644 --- a/docs/02_Onboarding/Development/start-local.md +++ b/docs/02_Onboarding/Development/start-local.md @@ -60,8 +60,8 @@ - Environment-Variablen: in `config/env/.env` und optional `config/env/.env.local`. ## Weiterführende Hinweise - - Architektur: `docs/ARCHITECTURE.md` - - ADRs: `docs/adr/` - - C4-Diagramme: `docs/c4/` + - Architektur: `docs/01_Architecture/ARCHITECTURE.md` + - ADRs: `docs/01_Architecture/adr/` + - C4-Diagramme: `docs/01_Architecture/c4/` Stand: Dezember 2025 diff --git a/docs/03_Agents/Playbooks/Junie.md b/docs/03_Agents/Playbooks/Junie.md index f1a32af9..7c5e6756 100644 --- a/docs/03_Agents/Playbooks/Junie.md +++ b/docs/03_Agents/Playbooks/Junie.md @@ -14,7 +14,7 @@ Junie wird genutzt für **Repo-nahe Arbeit**: Code lesen, reale Pfade/Module fin * Änderungen so klein wie möglich halten und den passenden Doku-Output erzeugen. ## Don’t -* Keine „zweite Wahrheit“ in `.junie/guidelines/*` etablieren. +* Keine „zweite Wahrheit“ in `.junie/*` etablieren (Tooling bleibt Tooling). * Keine Entscheidungen „im Chat verlieren“ – am Ende muss ein Artefakt in `docs/` stehen. ## Abschluss (Pflicht) diff --git a/docs/06_Infrastructure/Reference/ports-and-urls.md b/docs/06_Infrastructure/Reference/ports-and-urls.md index 55e196e0..7232dcb9 100644 --- a/docs/06_Infrastructure/Reference/ports-and-urls.md +++ b/docs/06_Infrastructure/Reference/ports-and-urls.md @@ -3,12 +3,15 @@ owner: project-maintainers status: active review_cycle: 180d last_reviewed: 2025-10-31 -summary: "Übersicht der wichtigsten lokalen URLs und Ports. Quelle: docker/versions.toml" +summary: "Übersicht der wichtigsten lokalen URLs und Ports. Quelle: docker-compose.yaml + config/env" --- # Referenz: Wichtige URLs und Ports (lokal) -Quelle der Wahrheit für Ports: [docker/versions.toml](../../docker/versions.toml) → [service-ports] +Quelle der Wahrheit für Ports/URLs (Repo-aktuell): + +* `docker-compose.yaml` +* `config/env/.env` (und optional `config/env/.env.local`) ## Infrastruktur @@ -39,7 +42,5 @@ Quelle der Wahrheit für Ports: [docker/versions.toml](../../docker/versions.tom ## Hinweise -- Die oben genannten Ports sind in `docker/versions.toml` unter `[service-ports]` zentral gepflegt und werden für Docker - Compose-Generierung und Validierung verwendet. -- Bei Port-Konflikten können die Werte in `docker/versions.toml` angepasst und anschließend die Compose-Dateien mit - `bash scripts/generate-compose-files.sh all development` neu generiert werden. +- Die oben genannten Ports sind aus dem aktuellen Compose-/Env-Setup abgeleitet. +- Bei Port-Konflikten passe die Werte in `config/env/.env` an (oder nutze lokale Overrides in `config/env/.env.local`). diff --git a/docs/99_Journal/2026-01.md b/docs/99_Journal/2026-01.md index 299fdafd..5ba90dcb 100644 --- a/docs/99_Journal/2026-01.md +++ b/docs/99_Journal/2026-01.md @@ -6,5 +6,5 @@ * **Kontext:** … * **Rollen genutzt:** … * **Ergebnis:** … (Link auf ADR/Note/How-to/Reference) -* **Offen:** … (Link auf `docs/00_Domain/questions.md` oder andere Parking Lots) +* **Offen:** … (Links auf relevante ADRs/Notes/Code-Stellen; optional: Eintrag im Journal reicht) * **Next:** …