README hinzugefügt für Beitragende, Justfile für schnelle Entwicklung und Hinweise in der Dokumentation angepasst

README.md

@@ -0,0 +1,28 @@
+# Anwenderdokumentation
+
+## Vorschlag zur Dokumentation einreichen
+
+Um einen Vorschlag zur Dokumentation einzureichen, erstellen Sie bitte ein Issue in diesem Repository. 
+Dort können Sie die gewünschte Änderung oder Ergänzung beschreiben und wir werden nach einer Lösung suchen.
+
+> [Einen Vorschlag einreichen](https://github.com/Streckenkunde/Anwenderdokumentation/issues/new/choose)
+
+## Entwicklung an der Dokumentation
+
+### Voraussetzungen an den Beitragenden
+
+Zum Beitragen an der Dokumentation sind folgende Voraussetzungen notwendig:
+
+- *[Docker](https://docs.docker.com/get-docker)* um die Dokumentation zu kompilieren und zu starten
+- Das Tool *[Just](https://just.systems)*, es ist ein Management-Tool für das Ausführen von Befehlen
+- Erfahrung im Umgang mit Markdown-Dateien und der Versionsverwaltung *[Git](https://git-scm.com)*
+
+### Befehle zur Entwicklung
+
+Folgende Befehle stehen dem Beitragenden zur Verfügung:
+
+| Befehl       | Beschreibung                                          |
+|--------------|-------------------------------------------------------|
+| `just build` | Baut die Dokumentation statisch in den Ordner `site`  |
+| `just serve` | Startet die Dokumentation auf `http://localhost:3000` |
+

docs/development/documentation.md

@@ -0,0 +1,25 @@
+# Dokumentation
+
+## Vorschlag zur Dokumentation einreichen
+
+Um einen Vorschlag zur Dokumentation einzureichen, erstellen Sie bitte ein Issue auf GitHub im Projekt zur
+Anwenderdokumentation. Dort können Sie die gewünschte Änderung oder eine Ergänzung mitteilen.
+
+> Hier können Sie [einen Vorschlag einreichen](https://github.com/Streckenkunde/Anwenderdokumentation/issues/new/choose)
+
+## Beitragen an der Dokumentation
+
+Wenn Sie an der Dokumentation mitarbeiten möchten, können Sie ihre Änderungen selbst in das Repository einpflegen.
+Dazu können Sie das Repository klonen und die Änderungen lokal vornehmen. Anschließend können Sie die Änderungen
+über einen Pull-Request einreichen und werden diese nach einer Prüfung in die Dokumentation überführen.
+
+> Mehr Informationen zum Beitragen finden Sie [in dem Repository](https://github.com/Streckenkunde/Anwenderdokumentation).
+
+### Voraussetzungen an den Beitragenden
+
+Zum Beitragen an der Dokumentation sind folgende Voraussetzungen notwendig:
+
+- *[Docker](https://docs.docker.com/get-docker)* um die Dokumentation zu kompilieren und zu starten
+- Das Tool *[Just](https://just.systems)*, es ist ein Management-Tool für das Ausführen von Befehlen
+- Erfahrung im Umgang mit Markdown-Dateien und der Versionsverwaltung *[Git](https://git-scm.com)*
+

docs/development/updates.md

@@ -1,9 +1,5 @@
 # Aktualisierungen und Updates
 
-## Aktuellste Version
-
-Die aktuellste Version ist 1.0.0
-
 ## Letzter Changelog
 
 Es wurde noch kein Changelog veröffentlicht.

justfile

@@ -0,0 +1,7 @@
+serve:
+    @echo "Der Entwicklungsserver für die Dokumentation wird gestartet"
+    docker run --rm -it -p 3001:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+
+build:
+    @echo "Die Dokumentation wird lokal gebaut"
+    docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

mkdocs.yml

@@ -26,5 +26,6 @@ nav:
       - Touren verwalten: manage/tour.md
       - Export der Daten: manage/export.md
   - Sonstiges:
-      - Schnittstellen: development/api.md
+      - Dokumentation: development/documentation.md
+      - Schnittstelle: development/api.md
       - Updates: development/updates.md