Dokumentation aktualisieren

Um die Dokumentationsseite zu aktualisieren, musst du:

Browser

edit page

  1. Klicke auf die Schaltfläche Edit page am Ende der Seite.

alt text

  1. Du wirst zur GitHub-Seite der Dokumentationsseite weitergeleitet. Hier kannst du deine Änderungen bearbeiten und eine Vorschau anzeigen.

Note

  • .md in CONTRIBUTING.md steht für Markdown-Dateien
  • .mdx in docs.mdx steht für MarkDown eXtended
    • es ist eine Obermenge von Markdown mit Unterstützung für JavaScript und JSX-Komponenten
    • sie sind etwas komplizierter, erlauben aber die Verwendung interaktiver Komponenten

propose changes window

  1. Klicke auf die Schaltfläche Commit changes... in der oberen rechten Ecke, um deine Änderungen zu committen. Stelle sicher, dass du:
  • Eine kurze und beschreibende Commit message schreibst
  • Das Kontrollkästchen Create a new branch for this commit and start a pull request aktivierst

comparing changes page

  1. Du wirst zur Seite Comparing changes weitergeleitet. Klicke auf die Schaltfläche Create pull request, um einen Pull Request zu erstellen.

open a pull request page

  1. Klicke auf die Schaltfläche Create pull request, um einen PR zu öffnen. Es ist in Ordnung, den PR-Text für kleine Änderungen leer zu lassen.

Lokale Entwicklung

Note

Dieser Abschnitt setzt voraus, dass du einige Kenntnisse in git und javascript hast. Natürlich kannst du sie auch währenddessen lernen.

Um die Dokumentationsseite lokal auszuführen, musst du:

  • deno installieren, um die Dokumentation zu formatieren und automatisch zu generieren

Einrichten des Entwicklungsservers

(Cataclysm-BN) $ deno task docs serve

# oder wenn du dich bereits im docs-Verzeichnis befindest
(Cataclysm-BN/docs) $ deno task serve

Du kannst unter http://localhost:3000 auf die Dokumentationsseite zugreifen. Der Entwicklungsserver wird automatisch neu geladen, wenn du Änderungen an der Dokumentation vornimmst.

Automatische Seitengenerierung

Lua- und CLI-Dokumentation werden automatisch aus dem Quellcode generiert. Um sie zu generieren, gehe zum Projektstammverzeichnis und führe aus:

(Cataclysm-BN) $ deno task docs:gen

Lizenz

  • Durch das Beitragen zu Markdown-Dateien (einschließlich, aber nicht beschränkt auf .md und .mdx Dateien), stimmst du zu, deine Beiträge unter CC-BY-SA 3.0 zu lizenzieren, derselben Lizenz wie das Spiel.

  • Durch das Beitragen zum Quellcode der Dokumentationsseite (einschließlich, aber nicht beschränkt auf .ts Dateien), stimmst du zu, deine Beiträge unter AGPL 3.0 zu lizenzieren.