Dokumentation des Projekts

Hallo zusammen,

über Umwege bin ich auf dieses Projekt gestoßen und hätte Lust es etwas zu Unterstützen :)

Beim durchstöbern und durchdringen des ganzen Umfangs ist mir eins aufgefallen:
Es gibt keinen roten Faden in der Gesamtdokumentation. D.h. man ist etwas Verloren, wenn man sich einem Überblick verschaffen möchte.
Manche Dinge scheinen auch etwas vermischt und ich hab mir oft die Frage gestellt: Was ist das hier nun genau?

Hier sehe ich Optimierungspotenzial und würde das ggf. selber in Angriff nehmen.

Folgende Themen sehe ich:

1. Es sollte ein Haupt-Repo geben das als Einstiegspunkt dient, in dem das Projekt Dokumentiert ist. Z.B. Worum geht es? Was sind die Ziele? Wie kann ich Unterstützen? Wo ist was? Anbieten würde sich dafür https://github.com/bundesAPI/apis alternativ könnte man aber auch ein eigenes Repo erstellen.
2. Dokumentation wie die Python Clients generiert werden
3. README für dieses Repo erstellen: https://github.com/bundesAPI/apis falls es nicht der Einstieg wird.
4. README erweitern, falls das Repo noch aktuell ist https://github.com/bundesAPI/openapi-status-check
5. Repo Umbennen und README erweitern: https://github.com/bundesAPI/landing
6. Issues aus https://github.com/bundesAPI/sofortmassnahmen gehören eig. eher in ein anderes Repo, da es dort ja eher um die Ausarbeitung des Vorschlags geht?
7. Wurde schon mal diskutiert ob die Dokumentationen in deutsch oder englisch verfasst werden sollen? Die APIs sind sicherlich auch für andere Personen in z.B. Europa interessant, die auf deutsche Daten zugreifen wollen.

Bevor ich mich nun aber fröhlich ans Werk mache, würde ich vorher gerne wissen ob die Änderungen grundsätzlich gewünscht sind oder ob bereits eine andere Struktur in Planung ist?

Start by reviewing the documentation structure across bundesAPI/apis, bundesAPI/openapi-status-check, bundesAPI/landing, and bundesAPI/sofortmassnahmen, including their existing READMEs. Read the issue discussion before proposing work. Done requires an agreed entry point, repository structure, documentation language, and clear README or documentation updates.

Written by the indexing model from the issue text.