# 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)*