Onboarding-Anleitung
Schließen Sie den geführten Onboarding-Ablauf ab: Projekt anlegen, GitHub verbinden, docs.json konfigurieren und den ersten Build starten.
Die 5 Schritte
Jamdesk startet bei Ihrer ersten Anmeldung Ihre 14-tägige kostenlose Testphase des Pro-Tarifs.
- Alle Funktionen sind aktiviert
- Die Testphase endet 14 Tage nach der Aktivierung
Benennen Sie Ihr Dokumentationsprojekt:
- Verwenden Sie einen klaren, beschreibenden Namen (z. B. „API-Dokumentation“, „Benutzerhandbuch“)
- Der Name wird Teil der URL Ihrer Dokumentationsseite
- Den Anzeigenamen können Sie später in den Projekteinstellungen ändern
Jamdesk erstellt ein neues GitHub-Repository aus der Starter-Vorlage:
- Beispielseiten mit realistischen Inhalten und Komponenten
- Vorkonfigurierte
docs.jsonmit Navigation und Branding - OpenAPI-Spezifikationsbeispiel für API-Referenzdokumentation
- Bereit zum Bearbeiten und Pushen
Installieren Sie die Jamdesk-CLI für die lokale Entwicklung:
npm install -g jamdeskDieser Schritt ist optional. Sie können die CLI jederzeit installieren oder die Dokumentation direkt auf GitHub bearbeiten.
Bearbeiten Sie Ihre Dokumentation:
- Über die CLI: Bearbeiten Sie Dateien lokal mit
jamdesk dev - Über GitHub: Bearbeiten Sie
.mdx-Dateien direkt in Ihrem Repository - Auf Jamdesk: Einige Dashboard-Funktionen sind verfügbar (je nach Tarif)
Jeder Push zu GitHub löst einen neuen Build aus.
Nach dem Onboarding
Als Nächstes können Sie:
Fehlerbehebung
Ich habe einen Schritt übersprungen. Kann ich zurückgehen?
Ja. Sie können das Onboarding jederzeit über die Onboarding-Karte im Dashboard Ihres Projekts abschließen.
Ich habe das falsche GitHub-Repository ausgewählt
Legen Sie ein neues Projekt mit dem richtigen Repository an. Das alte Projekt können Sie jederzeit löschen.
Ich benötige während des Onboardings Hilfe
Kontaktieren Sie den Support.