Onboarding-Anleitung

Die 5 Schritte

Testversion starten

Wenn Sie sich zum ersten Mal anmelden, startet Jamdesk automatisch Ihre 14-tägige kostenlose Testversion des Pro-Tarifs.

Vollständiger Zugriff auf alle Funktionen
Die Testversion endet 14 Tage nach der Aktivierung

Projekt erstellen

Geben Sie Ihrem Dokumentationsprojekt einen Namen:

Verwenden Sie einen eindeutigen, aussagekräftigen Namen (z. B. „API-Dokumentation“, „Benutzerhandbuch“)
Dieser Name wird Bestandteil der URL Ihrer Dokumentationswebsite
Sie können den Anzeigenamen später in den Projekteinstellungen ändern

GitHub verbinden und Starterdokumentation erstellen

Jamdesk erstellt ein neues GitHub-Repository aus der Startervorlage:

Beispielseiten mit realistischen Inhalten und Komponenten
Vorkonfigurierte docs.json mit Navigation und Branding
OpenAPI-Spezifikationsbeispiel für API-Referenzdokumentation
Sofort bearbeitungs- und bereitstellbar

CLI installieren

Die Jamdesk CLI ermöglicht die lokale Entwicklung:

npm install -g jamdesk

Sie können diesen Schritt während des Onboardings überspringen und die CLI jederzeit installieren. Wenn Sie ihn überspringen, können Sie die Dokumentation weiterhin direkt auf GitHub bearbeiten.

Bearbeitung starten

Sie können jetzt mit dem Build beginnen. Bearbeiten Sie Ihre Dokumentation:

Über die CLI: Bearbeiten Sie Dateien lokal mit jamdesk dev
Über GitHub: Bearbeiten Sie .mdx-Dateien direkt in Ihrem Repository
In Jamdesk: Einige Dashboard-Funktionen sind verfügbar (abhängig vom Tarif)

Änderungen lösen automatisch neue Dokumentations-Builds aus, wenn Sie sie auf GitHub pushen.

Nach dem Onboarding

Nach Abschluss des Onboardings können Sie:

Fehlerbehebung

Ich habe einen Schritt übersprungen. Kann ich zurückgehen?

Sie können das Onboarding jederzeit über Ihr Projekt-Dashboard abschließen. Suchen Sie nach der Onboarding-Karte, um dort fortzufahren, wo Sie aufgehört haben.

Ich habe das falsche GitHub-Repository ausgewählt

Erstellen Sie ein neues Projekt mit dem richtigen Repository. Sie können das alte jederzeit löschen.

Ich benötige während des Onboardings Hilfe

Wenden Sie sich jederzeit während des Prozesses an den Support.