mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize TODO list for documentation cleanup

Browse Source 
Marked all remaining documentation tasks as complete, including fixing broken links, correcting invalid HTML in legacy specifications, and adding missing placeholder READMEs. Resolved issues with new link inconsistencies and ensured the project is free of known documentation warnings.
This commit is contained in:
Stefan Mogeritsch 2026-01-15 13:58:14 +01:00
parent f4563a3da3
commit f6e644d433
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/99_Journal/2026-01-14_TODO_Final-Doc-Cleanup.md
View File

@ -2,38 +2,33 @@
* **Datum:** 2026-01-14 * **Datum:** 2026-01-14
* **Autor:** Documentation & Knowledge Curator * **Autor:** Documentation & Knowledge Curator
* **Status:** Offen * **Status:** Erledigt
## Kontext ## Kontext
Nach der großen Dokumentations-Restrukturierung sind beim Commit-Prozess Linting-Fehler und Link-Warnungen aufgetaucht. Diese Liste dient als Plan, um diese letzten Probleme in der nächsten Session zu beheben. Nach der großen Dokumentations-Restrukturierung sind beim Commit-Prozess Linting-Fehler und Link-Warnungen aufgetaucht. Diese Liste diente als Plan, um diese letzten Probleme in der Session vom 14.01.2026 zu beheben.
--- ---
## Offene Punkte ## Abarbeitung
Alle unten genannten Punkte wurden in der Session vom 14.01.2026 erfolgreich abgearbeitet.
### 1. "Broken Links" in Tech-Stack-Referenzen beheben ### 1. "Broken Links" in Tech-Stack-Referenzen beheben
* **Problem:** Die aus dem Web kopierten Dokumente (`Gradle_Kotlin_DSL_Primer.md`, `Kotlin_2-3-0_ReleaseNotes.md`) in `docs/02_Reference/Tech_Stack/` enthalten hunderte ungültige, relative Links, die von den Original-Webseiten stammen. * **Problem:** Die aus dem Web kopierten Dokumente (`Gradle_Kotlin_DSL_Primer.md`, `Kotlin_2-3-0_ReleaseNotes.md`) in `docs/02_Reference/Tech_Stack/` enthielten hunderte ungültige, relative Links.
* **Aktion:** * **Lösung:** Die Dateien wurden auf ihren reinen Inhalts-Kern reduziert und von fehlerhaften Links befreit.
* Öffne beide Dateien.
* Entferne die kompletten Navigations-Sidebars und alle anderen internen Links, die Fehler verursachen.
* Reduziere die Dateien auf ihren reinen Inhalts-Kern. Der Link zur Original-Quelle am Anfang jeder Datei ist ausreichend.
### 2. Ungültiges HTML in Legacy-Spezifikation korrigieren ### 2. Ungültiges HTML in Legacy-Spezifikation korrigieren
* **Problem:** Die Datei `docs/03_Domain/02_Reference/Legacy_Specs/OETO-2026_Meldestelle_Erweiterung-Schnittstelle_2014.md` enthält ungültige XML/HTML-Tags. * **Problem:** Die Datei `docs/03_Domain/02_Reference/Legacy_Specs/OETO-2026_Meldestelle_Erweiterung-Schnittstelle_2014.md` enthielt ungültige XML/HTML-Tags.
* **Aktion:** * **Lösung:** Der Inhalt wurde als Markdown-Code-Block vom Typ `xml` formatiert.
* Öffne die Datei.
* Formatiere den Inhalt als Markdown-Code-Block mit dem Typ `xml`, um die Struktur zu erhalten, ohne dass der Parser Fehler meldet.
### 3. Fehlende `README.md`-Dateien im `docs`-Verzeichnis erstellen ### 3. Fehlende `README.md`-Dateien im `docs`-Verzeichnis erstellen
* **Problem:** Die Wegweiser-READMEs in den Modulen `backend`, `core` und `contracts` zeigen auf nicht-existente Zieldateien. * **Problem:** Die Wegweiser-READMEs in den Modulen `backend`, `core` und `contracts` zeigten auf nicht-existente Zieldateien.
* **Aktion:** Erstelle die folgenden Platzhalter-Dateien, um die Links gültig zu machen: * **Lösung:** Die entsprechenden Platzhalter-Dateien (`docs/05_Backend/README.md`, `docs/03_Domain/01_Core_Model/README.md`) wurden erstellt. Ein dabei neu entstandener fehlerhafter Link zum API-Gateway wurde ebenfalls korrigiert.
* `docs/05_Backend/README.md` (mit einem kurzen Platzhaltertext)
* `docs/03_Domain/01_Core_Model/README.md` (mit einem kurzen Platzhaltertext)
--- ---
Nach Abarbeitung dieser Liste sollte das Projekt frei von Dokumentations-Warnungen sein. Das Projekt ist nun frei von den bekannten Dokumentations-Warnungen.