Zur Weblate-Dokumentation beitragen

Sie sind herzlich eingeladen, die Dokumentationsseite Ihrer Wahl zu verbessern. Klicken Sie dazu einfach auf die Schaltfläche Edit this page in der oberen rechten Ecke der Seite.

Dokumentationsrichtlinien

Bitte beachten Sie diese Richtlinien beim Schreiben:

  1. Entfernen Sie keinen gültigen Teil der Dokumentation.

  2. Verwenden Sie eine klare und leicht verständliche Sprache. Sie schreiben eine technische Dokumentation, kein Gedicht. Nicht alle Leser von Dokumentationen sind Muttersprachler, seien Sie rücksichtsvoll.

  3. Scheuen Sie sich nicht zu fragen, wenn Sie sich nicht sicher sind. Wenn Sie während dem Bearbeiten eine Frage zu einer Funktion haben, ändern Sie die Dokumentation nicht, bevor Sie die Antwort haben. Das bedeutet: Entweder Sie ändern oder Sie fragen. Tun Sie nicht beides gleichzeitig.

  4. Überprüfen Sie Ihre Änderungen, indem Sie die beschriebenen Aktionen durchführen und dabei die Dokumentation beachten.

  5. Senden Sie Pull Requests mit Änderungen in kleinen Teilen, damit sie leichter und schneller überprüft und zusammengeführt werden können.

  6. Wenn Sie einen großen Artikel umschreiben und seine Struktur ändern wollen, sollten Sie dies in zwei Schritten tun:

    1. Umschreiben

    2. Sobald die Neufassung geprüft, ausgefeilt und zusammengeführt wurde, ändern Sie die Struktur der Absätze in einem weiteren Pull Request.

Die Dokumentation lokal erstellen

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. If you already use the full development environment, uv sync --all-extras --dev is enough. For documentation work only, uv sync --group docs is sufficient.

Der empfohlene lokale Arbeitsablauf ist:

make -C docs update-docs
./ci/run-docs

The ci/run-docs wrapper builds the documentation with warnings treated as errors.

Hinweis

Zum Erstellen der Dokumentation muss außerdem graphviz installiert sein.

Die Dokumentation übersetzen

Sie können die Dokumentation übersetzen.

Generierte Dokumentationsausschnitte aktualisieren

Several documentation sections use templates generated from the code. The preferred way to refresh them is:

make -C docs update-docs

This target regenerates the snippets currently used by the documentation, including:

  • add-on events, built-in add-ons, and common add-on parameters

  • Maschinelle Übersetzungsdienste

  • Parameter für Dateiformate und Tabellen mit Funktionen für Dateiformate

  • Berechtigungen und integrierte Rollen

  • Überprüfungen und Überprüfungsmarkierungen

Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, Erweiterungen includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.

If you need to regenerate only one part, the individual management commands are documented in Verwaltungsbefehle, and the exact commands used by update-docs are listed in docs/Makefile.