starknet docs

Starknet Dokumentation Repository

Die Starknet Docs -Website, https://docs.starknet.io, wurde in Asciidoc geschrieben und mit Antora, einem statischen Website -Generator für Asciidoc, erstellt.

Beitrag zur Starknet -Dokumentation

Wenn Sie an der technischen Dokumentation von Starknet beigetragen möchten, enthält die folgende Tabelle schnelle Links, mit denen Sie beginnen können.

Frage	Ressource
Ich bin interessiert, wie halte ich bei?	Informationen darüber, wie Sie einen Beitrag leisten können, finden Sie in verschiedenen Möglichkeiten, um einen Beitrag zu leisten.
Gibt es grundlegende Richtlinien, die mir helfen?	Grundlegende Richtlinien, mit denen wir unsere Inhalte konsistent halten können, finden Sie in den Dokumentationsrichtlinien.
Gibt es einen Style Guide und ein Schreibhandbuch, den ich verwenden sollte?	Siehe den Supplementary Style Guide Starknet Dokumentation.
Wie richte ich meine Workstation ein?	Siehe Einrichtung Ihrer Umgebung.

Verschiedene Möglichkeiten, um einen Beitrag zu leisten

Es gibt verschiedene Möglichkeiten, wie Sie zu einer Starknet -Dokumentation beitragen können:

• Erstellen Sie ein GitHub -Problem.

• Senden Sie eine Pull -Anfrage (PR). Sie können einen lokalen Klon Ihrer eigenen Gabel des Starknet-Docs-Repositorys erstellen, Ihre Änderungen vornehmen und eine PR einreichen. Diese Option ist am besten, wenn Sie wesentliche Änderungen haben oder die Änderungen, die Sie schneller hinzuzufügen möchten, helfen.

Was passiert, wenn Sie PR einreichen?

Wenn Sie eine PR einreichen, überprüft das Starknet Docs -Team die PR und arrangiert nach Bedarf weitere technische Bewertungen. Wenn die PR Änderungen erfordert, fügen die Rezensenten der PR Kommentare hinzu. Wir können die Änderungen anfordern oder Sie wissen lassen, dass wir Ihre Inhalte in eine andere PR integriert haben. Gelegentlich können wir dem ursprünglichen PR direkt Commits hinzufügen. Wenn die PR überprüft wurde und alle Updates abgeschlossen sind, verbindet das Dokumentationsteam die PR und wendet sie auf die gültigen Version (n) an.

Tipps zum Autoring

• Starknet -Dokumentation ergänzender Stilhandbuch: Allgemeine Anleitung und Schreibanleitung.

Informationen zum Schreiben in Asciidoc finden Sie unter:

• Asciidoc -Sprachdokumentation

• Asciidoc -Syntax Schnellreferenz

Notiz

Es gibt mehrere Möglichkeiten, IDs, Quellcodeblöcke, Querversicherungen und Links zu codieren. Im Allgemeinen verwenden wir die explizitsten Codierungskonventionen für die Codierung, um die Code -Lesbarkeit zu priorisieren. Die meisten dieser Codierungskonventionen sind in Asciidoc Mark-up Schnellreferenz für Red Hat-Dokumentation aufgeführt

Bevor du anfing

1. Installieren Sie yarn , wenn es noch nicht installiert ist.

2. Installieren Sie npx , wenn es noch nicht installiert ist.

3. Klonen Sie dieses Repo entweder aus einer Gabel oder wenn Sie ein offizieller Mitarbeiter sind, direkt von starknet-io/starknet-docs .

4. Wechseln Sie in das starknet-docs Verzeichnis.

5. Führen Sie den Befehl yarn aus, um die Umgebung vorzubereiten:

    Garn

yarn sollte Ihre Umgebung vorbereiten, indem die erforderlichen Module basierend auf package-lock.json und package.json installiert werden. Wenn es erfolgreich war, sollten Sie in der Lage sein, Inhalte zu erstellen und anzunehmen.

Aufbau und Vorschau von Inhalten lokal

Nach dem Schreiben oder Bearbeiten von Inhalten, um Ihre Änderungen voranzutreiben:

1. Erstellen Sie den Inhalt, indem Sie das Skript build_local_site.sh erstellen:

   ./build_local_site.sh

   Dieser Befehl generiert die Website im Verzeichnis public_html .

2. Öffnen Sie die Website, indem Sie eine der folgenden Informationen durchführen:

   • Öffnen Sie die Startseite: <repo_root>/public_html/index.html .

   • Führen Sie den mit Antora verpackten HTTP -Server aus:

     npx http-server public_html -c-1

     Der Server wird ausgeführt und gibt Ihnen eine oder mehrere lokale URLs, mit denen Sie die Website anzeigen können. Zum Beispiel:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

Veröffentlichung von Starknet -Dokumenten auf GitHub (nur für Administratoren)

Der hochrangige Prozess zur Veröffentlichung von Dokumentationsänderungen in diesem Repository.

Während des Verlaufs der Inhaltsentwicklung fusionieren Autoren Niederlassungen mit Änderungen entweder direkt in main , nach Bedarf in einen sekundären Zweig, in dem diese Änderungen warten, bis wir bereit sind, sie zu veröffentlichen.

GitHub -Aktionen erstellen Git -Tags und -Seuren, die auf den Veröffentlichungen und Tags von Repo erscheinen.

Wenn ein Feature -Zweig in den main zusammengeführt wird, erstellt CHANGELOG.md GitHub -Aktion im Format v<version>.<major_update>.<minor_update> Anschließend wird die neuen Inhalte an docs.starknet.io veröffentlicht.

Verfahren

Verschmelzen einer Feature -Niederlassung in main automatisch Änderungen in der Feature -Filiale. Es sind keine zusätzlichen Schritte erforderlich.

GitHub erhöht die Versionsnummern in package.json und package-lock.json und aktualisiert CHANGELOG.md mit den Beschreibungen jeder PR, die gerade in main zusammengeführt wurden. . Aktualisieren Sie Ihre lokale main aus der Remote main mit einem der folgenden:

• Ziehen Sie die Änderungen an:

  starknet-docs (main) git pull

• Machen Sie eine Wiederbeschreibung von [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  Notiz

  Wenn Sie eine Gabel verwenden, ist Ihr Forked Repo standardmäßig origin . In diesem Fall sollten Sie den Namen upstream [email protected]:starknet-io/starknet-docs.git zuweisen. Verwenden Sie beim Wiederaufbau in den obigen Befehlen upstream statt origin .