iota wiki

Erkunden Sie das Wiki

Berichtsfehler · Thema anfordern

Inhaltsverzeichnis

• Über das Projekt
  • Gebaut mit
• Erste Schritte
  • Voraussetzungen
  • Lokale Entwicklung
• Beitragen
• Kontakt

Über das Projekt

Das IoTa Wiki ist ein zentraler Hub zum Eintritt in das IOTA -Ökosystem. Eine Community-gesteuerte Initiative zur Bereitstellung einer aktuellen Sammlung von Einführungen und weiteren Lesen über die Technologie, die Teams, die Community und alles dazwischen. So kann jeder lernen, wie man IOTA baut, adoptiert und mit IOTA ingeht, alles in einem Raum.

Gebaut mit

Das IOTA -Wiki wird mit TypeScript, Reactjs und Docusaurus v2.0 erstellt.

Erste Schritte

Voraussetzungen

• Git 1.8.2 oder höher.
• Node.js 16.10 oder höher.
• Modernes Garn, das durch Ausführen corepack enable aktiviert ist.

Vorschau vor Ort

Verwenden Sie die folgenden Schritte, um das Wiki lokal voranzutreiben. Detailliertere Skripte finden Sie unter konfigurierten Skripten als Referenz.

Bitte beachten Sie, dass das Wiki viele Inhalte hat. Derzeit dauert der erste Build eine Weile. Es werden Anstrengungen unternommen, um die Bauzeit in der Zukunft zu verkürzen.

1. Klonen Sie das Repository, indem Sie git clone https://github.com/iotaledger/iota-wiki.git ausführen und mit cd iota-wiki zum Verzeichnis gehen.
2. Installieren Sie Abhängigkeiten mit yarn .
3. Bereiten Sie die Umgebung vor, indem yarn prepare vorbereiten. Dies muss nur einmal erfolgen.
4. Vorschau des Wiki mit yarn start . Dadurch startet ein Entwicklungsserver, der dem Wiki mit heißer Reload -Funktionen serviert wird. Daher aktualisiert er Inhalte, nachdem Änderungen vorgenommen wurden.

Vorkonfigurierte Skripte

Skript	Erläuterung
prepare	Bereiten Sie die Umgebung vor, indem Sie Submodule Build überprüfen.
start	Starten Sie einen Entwicklungsserver, der das Wiki bedient, mit heißem Nachladen bei Änderungen.
start:section:{section}	Starten Sie einen Entwicklungsserver, der nur einen Abschnitt des Wiki bedient, mit heißem Nachladen bei Änderungen. Verfügbare Abschnitte sind build , get-started , learn und maintain .
build	Bauen Sie das Wiki. Um für die Produktion zu erstellen, überprüfen Sie die neueste Version der externen Dokumentation durch Ausführen yarn checkout:remote und setzen Sie die MODE auf production .
checkout:remote	Schauen Sie sich die neueste Version der externen Dokumentation an.
generate:api	Generieren Sie verfügbare API -Dokumentation, die über das Docusaurus OpenAPI -Plugin konfiguriert sind und Dokumentation aus dem Quellcode kompiliert.

Beitragen

Das IOTA -Wiki wird von den iF und Community -Beiträgen immer willkommen gehalten. Das DX -Team und verwandte Teams aus der IF werden alle Probleme überprüfen und Anfragen an diesem Repository begeben. Wenn Sie Fehler bemerken oder das Gefühl haben, dass etwas fehlt, können Sie ein Problem mit dem Team erstellen oder direkt eine Pull -Anfrage mit Vorschlägen erstellen. Hier ist ein grundlegender Workflow, um eine Pull -Anfrage zu öffnen:

1. Fork dieses Repository in Ihr eigenes Konto und klonen Sie es ( git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git )
2. Erstellen Sie eine Feature -Filiale für Ihre Änderungen ( git checkout -b feat/amazing-feature ).
3. Nehmen Sie Ihre Änderungen vor und sehen Sie sich optional lokal vor.
4. Führen Sie yarn format und yarn lint aus und beheben Sie alle verbleibenden Fehler und Warnungen.
5. Bestimmen Sie Ihre Änderungen ( git commit -m 'Add some amazing feature' ).
6. Drücken Sie Ihre Änderungen in Ihre Gabel ( git push origin feat/amazing-feature ).
7. Öffnen Sie eine Pull -Anfrage an der main dieses Repositorys.

Schauen Sie sich einen Beitrag zur weiteren Anleitung an.

Versioning

Um herauszufinden, wie Sie Ihre Dokumente verstellen, lesen Sie diesen Leitfaden.

Online-Ein-Klick-Setup für den Beitrag

Sie können Gitpod (eine kostenlose, online, vs Code-ähnliche IDE) für den Beitrag verwenden. Mit einem einzigen Klick wird es alles vorbereiten, was Sie für das Wiki erstellen und beitragen. Klicken Sie einfach auf diese Schaltfläche und überspringen Sie Schritt 1 von oben.

Kontakt

Phylo - Phyloiota - Phylo [Community DAO - Los Los!]#2233
Jeroen van den Hout - Jlvandenhout - JVDHOUT#4402
Dr.Lectron - DR -Electron - Dr.Lectron#9370
Kritisch - Kilianhln - kritisch#7111
JSTO - JSTO91 - JSTO#3746