StefanMoCoAt
33f1c0fab5
### Summary - Updated root `README.md` to reflect the new Backend/Frontend structure. - Rewrote the project structure section to show `backend/` and `frontend/` with their submodules, and `docs/adr` + `docs/c4`. - Corrected Gradle module examples from old `:members:members-service` paths to `:backend:services:results:results-service` for both `bootRun` and `test` examples. - Verified links now point to `docs/adr` and `docs/c4`. - Updated `docs/README.md` to ensure flat paths: - Confirmed ADR and C4 links point to `adr/` and `c4/` respectively. - Updated the footer note to today’s date and linked ADR-0009. These changes align the docs with the consolidated, flat documentation layout and the finalized module structure. Ref: MP-30
3.6 KiB
3.6 KiB
Meldestelle - Dokumentation
📚 Single Source of Truth: YouTrack
Die Hauptdokumentation befindet sich in der YouTrack Wissensdatenbank:
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:
- ADR Übersicht
- ADR-0001: Modulare Architektur
- ADR-0002: Domain-Driven Design
- ADR-0003: Microservices
- ADR-0004: Event-Driven Communication
- ADR-0005: Polyglot Persistence
- ADR-0006: Authentication & Authorization (Keycloak)
- ADR-0007: API Gateway Pattern
- ADR-0008: Multiplatform Client Applications
- ADR-0009: Final KMP Architecture
2. C4-Diagramme (PlantUML-Quellen)
Versionierte Diagramm-Quellen für Architekturdokumentation:
3. Developer Guides
Minimale Anleitungen für lokale Entwicklung:
- Lokales Setup – Projekt in 5 Minuten starten
- KDoc Style Guide – Documentations-Konventionen im Code
- Branch-Schutz & PR-Workflow – Git-Workflow
🔄 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
- KDoc im Code schreiben
- PR erstellen → CI validiert
- Nach Merge → KDoc-Sync pusht automatisch nach YouTrack
Für Architektur-Entscheidungen
- ADR in
docs/adr/erstellen - PR mit ADR-Review
- Nach Merge → Zusammenfassung in YouTrack verlinken
Für Infrastruktur/Konfiguration
- Dokumentation direkt in YouTrack erstellen
- Bei Code-relevanten Änderungen → im Commit-Message auf YouTrack-Artikel verweisen
❓ Fragen & Support
- Technische Fragen: GitHub Discussions
- Bugs: GitHub Issues
- Architektur-Diskussionen: YouTrack
- Projekt-Dokumentation: YouTrack Wissensdatenbank
Hinweis: Diese README wurde am 8. Dezember 2025 aktualisiert im Rahmen der Dokumentations-Migration nach YouTrack (siehe ADR-0009).