mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
034892e890
meldestelle/docs
History
StefanMo 034892e890
chore(MP-23): network DI client, frontend architecture guards, detekt & ktlint setup, docs, ping DI factory (#21) 
* chore(MP-21): snapshot pre-refactor state (Epic 1)

* chore(MP-22): scaffold new repo structure, relocate Docker Compose, move frontend/backend modules, update Makefile; add docs mapping and env template

* MP-22 Epic 2: Erfolgreich umgesetzt und verifiziert

* MP-23 Epic 3: Gradle/Build Governance zentralisieren
2025-11-30 23:14:00 +01:00
..
adr chore(MP-23): network DI client, frontend architecture guards, detekt & ktlint setup, docs, ping DI factory (#21) 2025-11-30 23:14:00 +01:00
architecture Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
clients chore(MP-23): network DI client, frontend architecture guards, detekt & ktlint setup, docs, ping DI factory (#21) 2025-11-30 23:14:00 +01:00
how-to fix(doc): fixing Lint Critical Markdown (MP-17) (#17) 2025-11-12 00:10:44 +01:00
reference Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
.frontmatter.schema.json Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
ARCHITECTURE.md chore(MP-23): network DI client, frontend architecture guards, detekt & ktlint setup, docs, ping DI factory (#21) 2025-11-30 23:14:00 +01:00
README.md Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00

README.md

Meldestelle - Dokumentation

📚 Single Source of Truth: YouTrack

Die Hauptdokumentation befindet sich in der YouTrack Wissensdatenbank:

👉 Meldestelle Command Center

Was du in YouTrack findest

  • 🏗️ Bounded Context Dokumentation (Members, Horses, Events, Masterdata)
  • 📡 API-Referenz (automatisch aus KDoc generiert)
  • 🚀 Deployment-Guides (Proxmox, Cloudflare, Nginx)
  • 🔐 Sicherheit-Konfigurationen (Keycloak, GitHub Secrets)
  • 💡 Roadmap & Visionen
  • 📊 Architektur-Diagramme (interaktiv)

📂 Was im Repository bleibt

1. Architecture Decision Records (ADRs)

Architekturentscheidungen sind Teil der Code-Historie und werden im Repository versioniert:

2. C4-Diagramme (PlantUML-Quellen)

Versionierte Diagramm-Quellen für Architekturdokumentation:

3. Developer Guides

Minimale Anleitungen für lokale Entwicklung:

🔄 Automatische Synchronisation

Das Projekt nutzt automatisierte Workflows für Konsistenz:

  • KDoc → YouTrack: docs-kdoc-sync.yml – Synchronisiert API-Dokumentation aus Code-Kommentaren nach YouTrack
  • Docker SSoT: ssot-guard.yml – Validiert Docker-Versionskonsistenz
  • CI Pipeline: ci-main.yml – Hauptpipeline für Build, Tests, Validierung

📋 Documentations-Workflow

Für Code-Änderungen

  1. KDoc im Code schreiben
  2. PR erstellen → CI validiert
  3. Nach Merge → KDoc-Sync pusht automatisch nach YouTrack

Für Architektur-Entscheidungen

  1. ADR in docs/architecture/adr/ erstellen
  2. PR mit ADR-Review
  3. Nach Merge → Zusammenfassung in YouTrack verlinken

Für Infrastruktur/Konfiguration

  1. Dokumentation direkt in YouTrack erstellen
  2. Bei Code-relevanten Änderungen → im Commit-Message auf YouTrack-Artikel verweisen

❓ Fragen & Support

Hinweis: Diese README wurde am 30. Oktober 2025 aktualisiert im Rahmen der Documentations-Migration nach YouTrack ( siehe ADR-0009 - folgt).