---
title: Onboarding-Anleitung
description: "Richten Sie Ihre erste Dokumentationswebsite ein: Projekt erstellen, GitHub verbinden, docs.json konfigurieren und den ersten Build auslösen."
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

## Die 5 Schritte

<Steps>
  <Step title="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
  </Step>

  <Step title="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
  </Step>

  <Step title="GitHub verbinden und Starterdokumentation erstellen">
    Jamdesk erstellt ein neues GitHub-Repository aus der [Startervorlage](https://github.com/jamdesk/starter-docs):

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

  <Step title="CLI installieren">
    Die Jamdesk CLI ermöglicht die lokale Entwicklung:

    ```bash
    npm install -g jamdesk
    ```

    <Note>
    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.
    </Note>
  </Step>

  <Step title="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.
  </Step>
</Steps>

## Nach dem Onboarding

Nach Abschluss des Onboardings können Sie:
- [Zusätzliche Projekte erstellen](/de/help/projects/creating)
- [Teammitglieder einladen](/de/help/projects/team-members)
- [Analysen anzeigen](/de/setup/analytics-overview)
- [Benutzerdefinierte Domains konfigurieren](/de/deploy/custom-domains)

## 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](/de/help/support/contact).

## Verwandte Artikel

<Columns cols={2}>
  <Card title="Erster Build" icon="hammer" href="/de/help/getting-started/first-build">
    Ersten Build auslösen und überprüfen
  </Card>
  <Card title="Dashboard-Rundgang" icon="compass" href="/de/help/getting-started/dashboard-tour">
    Das Jamdesk-Dashboard kennenlernen
  </Card>
</Columns>