Jamdesk Documentation logo

Parcours d'onboarding

Suivez le parcours guidé pour configurer votre premier site : créez un projet, connectez GitHub, configurez docs.json et lancez votre premier build.

Les 5 étapes

1
Démarrer l'essai

Dès votre première connexion, Jamdesk démarre automatiquement votre essai gratuit de 14 jours du plan Pro.

  • Accès complet à toutes les fonctionnalités
  • L'essai se termine 14 jours après l'activation
2
Créer un projet

Donnez un nom à votre projet de documentation :

  • Utilisez un nom clair et descriptif (par ex. « API Documentation », « User Guide »)
  • Ce nom fait partie de l'URL de votre site de documentation
  • Vous pourrez modifier le nom d'affichage plus tard dans les paramètres du projet
3
Connecter GitHub et créer les docs de démarrage

Jamdesk crée un nouveau dépôt GitHub à partir du modèle de démarrage :

  • Pages d'exemple avec contenu et composants réalistes
  • docs.json préconfiguré avec navigation et image de marque
  • Exemple de spécification OpenAPI pour les pages de référence API
  • Prêt à modifier et pousser immédiatement
4
Installer la CLI

La CLI Jamdesk permet le développement local :

npm install -g jamdesk

Vous pouvez ignorer cette étape pendant l'onboarding et installer la CLI à tout moment. Si vous l'ignorez, vous pouvez toujours modifier la documentation directement sur GitHub.

5
Commencer à éditer

Vous êtes prêt à créer votre build ! Modifiez votre documentation :

  • Via la CLI : modifiez les fichiers localement avec jamdesk dev
  • Via GitHub : modifiez les fichiers .mdx directement dans votre dépôt
  • Sur Jamdesk : certaines fonctionnalités du dashboard sont disponibles (selon le plan)

Les modifications déclenchent automatiquement des reconstructions de la documentation lorsque vous poussez vers GitHub.

Après l'onboarding

Une fois l'onboarding terminé, vous pouvez :

Dépannage

J'ai ignoré une étape, puis-je revenir en arrière ?

Vous pouvez terminer l'onboarding à tout moment depuis le dashboard de votre projet. Recherchez la carte d'onboarding pour reprendre où vous vous étiez arrêté.

J'ai choisi le mauvais dépôt GitHub

Créez un nouveau projet avec le bon dépôt. Vous pouvez supprimer l'ancien à tout moment.

J'ai besoin d'aide pendant l'onboarding

Contactez le support à tout moment pendant le processus.

Articles connexes

Premier build

Lancez et vérifiez votre premier build

Visite du dashboard

Découvrez le dashboard Jamdesk