Procedura di onboarding
Completa il flusso guidato di onboarding per configurare il tuo primo sito di documentazione: crea un progetto, collega GitHub, configura docs.json e avvia la prima build.
I 5 passaggi
Jamdesk avvia la tua prova gratuita di 14 giorni del piano Pro al primo accesso.
- Tutte le funzionalità sono attive
- La prova termina 14 giorni dopo l'attivazione
Assegna un nome al tuo progetto di documentazione:
- Usa un nome chiaro e descrittivo (ad esempio "Documentazione API", "Guida utente")
- Il nome diventa parte dell'URL del tuo sito di documentazione
- Puoi modificare il nome visualizzato in seguito nelle impostazioni del progetto
Jamdesk crea un nuovo repository GitHub a partire dal Starter Template:
- Pagine di esempio con contenuti e componenti realistici
docs.jsonpreconfigurato con navigazione e branding- Esempio di specifica OpenAPI per la documentazione di riferimento delle API
- Pronto per essere modificato e pubblicato
Installa la CLI di Jamdesk per lo sviluppo locale:
npm install -g jamdeskQuesto passaggio è facoltativo. Puoi installare la CLI in qualsiasi momento oppure modificare la documentazione direttamente su GitHub.
Modifica la tua documentazione:
- Tramite CLI: modifica i file in locale con
jamdesk dev - Tramite GitHub: modifica direttamente i file
.mdxnel tuo repository - Su Jamdesk: alcune funzionalità della dashboard sono disponibili (in base al piano)
Ogni push su GitHub avvia una nuova build.
Dopo l'onboarding
Successivamente, puoi:
- Creare progetti aggiuntivi
- Invitare membri del team
- Visualizzare le analisi
- Configurare domini personalizzati
Risoluzione dei problemi
Ho saltato un passaggio: posso tornare indietro?
Sì. Puoi completare l'onboarding in qualsiasi momento dalla scheda di onboarding nella dashboard del progetto.
Ho scelto il repository GitHub sbagliato
Crea un nuovo progetto con il repository corretto. Puoi eliminare quello vecchio in qualsiasi momento.
Ho bisogno di aiuto durante l'onboarding
Contatta il supporto.