Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olibrian committed Jan 15, 2024
1 parent f6efb54 commit 6d87c7f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Die Benutzerdokumentation von Hitobito bringt einige Herausforderungen mit sich.

## Generische Dokumentation

* Ziel: Allgemeine Dokumentation mit einem überblick, was Hitobito alles kann. Ohne die spezifischen Anpassungen an den Wagons.
* Ziel: Allgemeine Dokumentation mit einem Überblick, was Hitobito alles kann. Ohne die spezifischen Anpassungen an den Wagons.
* Zielgruppe: Personen welche mehr über Hitobito wissen wollen und einen Überblick was alles möglich ist
* Diese Doku wird gemeinsam gepflegt
* Bemerkungen oder eine Infobox falls das Modul in mehreren Wagons oft oder gross abweicht. Analog der Dokumentation der [Rechnungen](https://hitobito.readthedocs.io/de/latest/access_concept.html)
Expand All @@ -32,7 +32,7 @@ Hier eine Sammlung von User Dokumentation/Dokumente von den Community Mitglieder

## Contribute generic user documentation (this repo)

This will be built with https://readthedocs.org/. The readthedocs page is rebuilt with each merged PR. At https://readthedocs.org/projects/hitobito/builds/ you can check whether the build was successful.
This will be built with https://readthedocs.org/. The readthedocs page is rebuilt with each merged PR. At https://readthedocs.org/projects/hitobito/builds/ you can check whether the build was successful. If you are unsure, you can first merge into the beta branch. This is also built and can be reached at https://hitobito.readthedocs.io/de/beta/

A helpful overview over the restructured syntax that we use can be found here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Expand Down

0 comments on commit 6d87c7f

Please sign in to comment.