Skip to content

Commit 11fe720

Browse files
authored
📄Update README (#776)
* 📄Update README * 📄Improve Doku - Code review
1 parent 3975ad4 commit 11fe720

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,22 @@ Dabei sind unsere Designentscheidungen:
5252

5353
Dokumentation / Fragen und Anregungen zum BO4E Datenmodell
5454
==========================================================
55-
Eine Dokumentation des Datenmodells und JSON Schemata zur Erzeugung von Beispieldaten finden sich auf `read the docs <https://bo4e-python.readthedocs.io/en/latest/api/modules.html>`_.
55+
Die Dokumentation ist verfügbar unter `<https://bo4e.github.io/BO4E-python/>`_.
56+
Die Doku wird erst seit Version `v202401.0.3 <https://bo4e.github.io/BO4E-python/v202401.0.3>`_ mittels
57+
GitHub Pages gehosted.
58+
Die früheren Versionen sind auf `read the docs <https://bo4e-python.readthedocs.io/en/latest/api/modules.html>`_
59+
einsehbar.
60+
61+
Unter `/latest` findet sich die Dokumentation des aktuellen Stands des main-Branches. `/stable` zeigt immer auf die
62+
letzte veröffentlichte Version (Release candidates ausgeschlossen).
63+
Zusätzlich ist jede Version (inklusive Release candidates) unter `/v<version>` auffindbar.
64+
65+
Die Doku bietet eine Übersicht über alle Klassen und Attribute, die im BO4E Standard definiert sind. Außerdem
66+
werden alle Beziehungen zwischen den Klassen durch Diagramme visualisiert. Die JSON-Schemas sind ebenfalls verlinkt.
67+
Alternativ können die JSON-Schemas auch direkt von GitHub heruntergeladen werden: `<https://github.com/bo4e/BO4E-Schemas>`_.
68+
Seit Version `v202401.1.1 <https://bo4e.github.io/BO4E-python/v202401.1.1>`_ gibt es zusätzlich eine
69+
`Kompatibilitätsmatrix <https://bo4e.github.io/BO4E-python/v202401.1.1/changelog.html>`_,
70+
die für jedes Objekt zeigt, zwischen welchen Versionen es einen "breaking change" gab.
5671

5772
Bei Fragen oder Anregungen, bitte `einfach ein Issue in diesem Repo aufmachen <https://github.com/Hochfrequenz/BO4E-python/issues/new?assignees=&labels=BO4E+Enhancement+Proposal&template=funktionale-anforderung-an-den-bo4e-standard.md&title=Ein+aussagekr%C3%A4ftiger+Titel%3A+Hunde-+und+Katzentarife+k%C3%B6nnen+nicht+abgebildet+werden>`_.
5873

0 commit comments

Comments
 (0)