README auf aktuellen Contract- und Dokumentationsstand bringen #1

New issue

Open

opened 2026-08-10 05:38:20 +02:00 by michael · 0 comments

michael commented

2026-08-10 05:38:20 +02:00

Owner

Ziel

Das öffentliche README von DAW/daw-contracts auf den aktuellen Stand des Repositories und der neuen Dokumentationsstruktur bringen.

Aktueller Anlass

Die bisherige Contract-Liste nennt unter anderem daw_log/v1 und bildet den heutigen Bestand nicht mehr vollständig ab.

Aktuell sichtbar sind mindestens:

daw_channel_log/v1
daw_content_syslog/v1
daw_error/v1
daw_error_report/v1
daw_event/v1
daw_event_response/v1
mainjan/v1

Dokumentationsgrenze

Das Repository bleibt die Quelle für normative Contracts, Versionen und technische Artefakte.

Hintergründe, Gestaltungsentscheidungen und vertiefende Erklärungen sollen künftig im DAW-Bereich der Wissensplattform liegen und vom README aus erreichbar sein.

Akzeptanzkriterien

Contract-Liste entspricht dem tatsächlichen Repository-Stand
Zweck und Scope des Repositories bleiben unmittelbar verständlich
README trennt normative Repository-Inhalte von vertiefender Wissensdokumentation
Veraltete Hinweise auf daw_log/v1 sind entfernt oder historisch korrekt eingeordnet
Repository-Struktur, Statusmodell und Lizenzhinweise sind weiterhin korrekt

## Ziel Das öffentliche README von `DAW/daw-contracts` auf den aktuellen Stand des Repositories und der neuen Dokumentationsstruktur bringen. ## Aktueller Anlass Die bisherige Contract-Liste nennt unter anderem `daw_log/v1` und bildet den heutigen Bestand nicht mehr vollständig ab. Aktuell sichtbar sind mindestens: - `daw_channel_log/v1` - `daw_content_syslog/v1` - `daw_error/v1` - `daw_error_report/v1` - `daw_event/v1` - `daw_event_response/v1` - `mainjan/v1` ## Dokumentationsgrenze Das Repository bleibt die Quelle für normative Contracts, Versionen und technische Artefakte. Hintergründe, Gestaltungsentscheidungen und vertiefende Erklärungen sollen künftig im DAW-Bereich der Wissensplattform liegen und vom README aus erreichbar sein. ## Akzeptanzkriterien - [ ] Contract-Liste entspricht dem tatsächlichen Repository-Stand - [ ] Zweck und Scope des Repositories bleiben unmittelbar verständlich - [ ] README trennt normative Repository-Inhalte von vertiefender Wissensdokumentation - [ ] Veraltete Hinweise auf `daw_log/v1` sind entfernt oder historisch korrekt eingeordnet - [ ] Repository-Struktur, Statusmodell und Lizenzhinweise sind weiterhin korrekt

michael added the

labels

2026-08-10 05:38:20 +02:00