Guida onboarding

I 5 passaggi

Avvia prova

Al primo accesso, Jamdesk avvia automaticamente la tua prova gratuita di 14 giorni del piano Pro.

Accesso completo a tutte le funzionalità
La prova termina 14 giorni dopo l'attivazione

Crea progetto

Assegna un nome al progetto di documentazione:

Usa un nome chiaro e descrittivo (ad es. "Documentazione API", "Guida utente")
Il nome diventa parte dell'URL del sito di documentazione
Puoi modificare in seguito il nome visualizzato nelle impostazioni del progetto

Collega GitHub e crea i documenti iniziali

Jamdesk crea un nuovo repository GitHub dal Starter Template:

Pagine di esempio con contenuti e componenti realistici
docs.json preconfigurato con navigazione e branding
Esempio di specifica OpenAPI per la documentazione di riferimento API
Pronto per essere modificato e inviato immediatamente

Installa CLI

La CLI di Jamdesk abilita lo sviluppo locale:

npm install -g jamdesk

Puoi saltare questo passaggio durante l'onboarding e installare la CLI in qualsiasi momento. Se lo salti, puoi comunque modificare la documentazione direttamente su GitHub.

Inizia a modificare

Ora puoi creare! Modifica la documentazione:

Tramite CLI: modifica i file localmente con jamdesk dev
Tramite GitHub: modifica direttamente i file .mdx nel repository
Su Jamdesk: alcune funzionalità del dashboard sono disponibili (a seconda del piano)

Quando esegui il push su GitHub, le modifiche avviano automaticamente nuove build della documentazione.

Dopo l'onboarding

Dopo aver completato l'onboarding, puoi:

Risoluzione dei problemi

Ho saltato un passaggio: posso tornare indietro?

Puoi completare l'onboarding in qualsiasi momento dal dashboard del progetto. Cerca la scheda dell'onboarding per riprendere dal punto in cui ti sei fermato.

Ho scelto il repository GitHub sbagliato

Crea un nuovo progetto con il repository corretto. Puoi eliminare quello precedente in qualsiasi momento.

Ho bisogno di aiuto durante l'onboarding

Contatta il supporto in qualsiasi momento durante la procedura.