Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📄Update README #776

Merged
merged 3 commits into from
Apr 30, 2024
Merged

📄Update README #776

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79d3a82
📄Update README
lord-haffi Apr 30, 2024
1671316
📄Improve Doku - Code review
lord-haffi Apr 30, 2024
843f9d6
Merge remote-tracking branch 'origin/main' into update_readme
lord-haffi Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,20 @@ Dabei sind unsere Designentscheidungen:

Dokumentation / Fragen und Anregungen zum BO4E Datenmodell
==========================================================
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>`_.
Die Dokumentation des Datenmodells befand sich früher auf `read the docs <https://bo4e-python.readthedocs.io/en/latest/api/modules.html>`_.
Seit Version `v202401.0.3 <https://bo4e.github.io/BO4E-python/v202401.0.3>`_ wird diese jedoch mittels
`GitHub Pages <https://bo4e.github.io/BO4E-python>`_ gehosted.
lord-haffi marked this conversation as resolved.
Show resolved Hide resolved

Unter `/latest` findet sich die Dokumentation des aktuellen Stands des main-Branches. `/stable` zeigt immer auf die
letzte veröffentlichte Version (Release candidates ausgeschlossen).
Zusätzlich ist jede Version (auch Release candidates) unter `/v<version>` auffindbar.

Die Doku bietet eine Übersicht über alle Klassen und Attribute, die im BO4E Standard definiert sind. Außerdem
werden alle Beziehungen zwischen den Klassen durch Diagramme visualisiert. Die JSON-Schemas sind ebenfalls verlinkt.
Alternativ können die JSON-Schemas auch direkt von GitHub heruntergeladen werden: `<https://github.com/bo4e/BO4E-Schemas>`_.
Seit Version `v202401.1.1 <https://bo4e.github.io/BO4E-python/v202401.1.1>`_ gibt es zusätzlich eine
`Kompatibilitätsmatrix <https://bo4e.github.io/BO4E-python/v202401.1.1/changelog.html>`_,
die für jedes Objekt zeigt, zwischen welchen Versionen es einen "breaking change" gab.

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>`_.

Expand Down
Loading