mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
84337697ce
meldestelle/docs/README.md
Stefan Mogeritsch 84337697ce docs: update code block formatting in reports and restructure guides 
Updated code block formatting in `Ping-Service_Impl_01-2026.md` for consistency by switching from `kotlin` to `text`. Refactored `README.md` to rename `02_Onboarding` to `02_Guides` for improved clarity. Adjusted UI code example in `UIUXDesigner.md` with added descriptive comments.
2026-01-23 13:39:07 +01:00

1.7 KiB
Raw Blame History

📚 Projektdokumentation "Meldestelle"

Willkommen im "Gehirn" des Projekts. Dieses Verzeichnis ist die Single Source of Truth.

📂 Struktur

🏗️ Core

  • 01_Architecture: Der Masterplan. ADRs, Roadmaps und C4-Modelle.
    • Start hier: MASTER_ROADMAP_2026_Q1.md
  • 02_Guides: Guides für neue Entwickler (Setup, Guidelines).
  • 03_Domain: Fachlichkeit (Turnierregeln, Entities).

🛠️ Tech Stack

  • 05_Backend: Spring Boot Services, API-Specs, DB-Schema.
    • Referenz: Services/PingService_Reference.md
  • 06_Frontend: Kotlin Multiplatform, Compose UI, State Management.
  • 07_Infrastructure: Docker, Keycloak, CI/CD.

🤖 Process

📝 Regeln für die Dokumentation

  1. Docs-as-Code: Doku liegt beim Code und wird im selben PR aktualisiert.
  2. Frontmatter: Jede Markdown-Datei muss einen YAML-Header haben: 
    ---
type: [ADR, Guide, Reference, Report, Journal]
status: [DRAFT, ACTIVE, DEPRECATED, ARCHIVED]
owner: [Rolle]
---
  3. Archivierung: Lösche nichts. Verschiebe veraltetes Wissen in _archive Ordner oder markiere es als ARCHIVED.

🚀 Quick Links