Skip to main content
Bienvenue ! Nous sommes ravis que vous souhaitiez contribuer au wiki d’Astral Realms. Ce guide vous accompagnera pas à pas, même si vous n’avez jamais utilisé Gitkraken ou VSCode.
Vous n’avez besoin d’aucune expérience préalable ! Ce guide est conçu pour les débutants complets.

​
Prérequis

Avant de commencer, vous aurez besoin de :

Un compte GitHub

Si vous n’en avez pas encore, créez-en un gratuitement sur github.com

Installer Nodejs

Installez l’application créez-en un gratuitement sur nodejs.org

Installer VSCode

Installez l’application créez-en un gratuitement sur code.visualstudio.com

Installer Gitkraken

Installez l’application créez-en un gratuitement sur www.gitkraken.com

Avant de pouvoir commencer à suivre le tutoriel, vous devez d’abord faire un ticket sur le discord pour nous transmettre votre pseudo GitHub afin que nous puissions vous ajouter dans l’équipe.
Si jamais vous n’arrivez pas à faire une étape ou que vous avez besoin d’aide, n’hésitez pas à nous contacter sur Discord ! Nous sommes là pour vous aider.

​
Étape 1 : Installer Mint

Mint est l’outil de développement que nous utilisons pour construire et prévisualiser le wiki. Il est très facile à installer.
  1. Ouvrez un terminal (sur Mac : Terminal, sur Windows : PowerShell ou Command Prompt)
  2. Tapez la commande suivante et appuyez sur Entrée :
  1. Si vous êtes sur Windows, vous devrez peut-être ajuster la politique d’exécution pour permettre l’installation de Mint.
Ouvrir PowerShell et tapez la commande suivante et appuyez sur Entrée :

​
Étape 2 : Installer les Extensions Mintlify pour VSCode

VSCode est un éditeur de code gratuit et très puissant.
  1. Allez sur code.visualstudio.com
  2. Cliquez sur le bouton de téléchargement pour votre système
  3. Lancez l’installateur et suivez les étapes (options par défaut recommandées)
Astuce : Cochez la case “Add ‘Open with Code’ to action” (ou équivalent) lors de l’installation pour pouvoir ouvrir des dossiers directement depuis VSCode.
  1. Une fois VSCode installé, ouvrez-le et allez dans l’onglet des extensions (icône de carré avec quatre carrés à l’intérieur)
  2. Recherchez “Mintlify” et installez les extensions suivantes :
Mintlify extensions

​
Étape 3 : Clone le dépôt GitHub sur VSCode

VSCode
  1. Identifiez-vous sur VSCode avec votre compte GitHub.
  2. Cliquez sur “Clone Git Repository…” Une liste s’ouvre, sélectionnez “astral-realmsmc/docs” et cliquez dessus.
AR repo

​
Étape 4 : Clone le dépôt GitHub sur Gitkraken

  1. Cliquez sur « GitHub.com ».
  2. Authentifiez-vous avec votre compte GitHub.
  3. Sélectionnez le dossier de destination du dépôt.
  4. Choisissez le dépôt docs de l’organisation Astral-RealmsMC.
  5. Cliquez sur « Clone the repo! » afin de cloner le dépôt sur votre ordinateur.
Gitkraken

​
Étape 5 : Faire vos modifications

Maintenant vous pouvez modifier les fichiers !
  1. Dans l’explorateur de fichiers (gauche), faites un clic droit
  2. Sélectionnez “New File”
  3. Donnez un nom au fichier avec l’extension .mdx
  4. Exemple : ma-nouvelle-page.mdx
  1. Cliquez sur le fichier que vous voulez modifier
  2. Faites vos changements dans l’éditeur
  3. Sauvegardez avec Cmd+S (Mac) ou Ctrl+S (Windows/Linux)
Format des fichiers : Nous utilisons le format MDX (Markdown avec des composants). C’est comme du Markdown normal mais avec des composants Mintlify supplémentaires.

​
Étape 6 : Prévisualiser vos changements

Avant de proposer vos changements, vous pouvez les voir en direct.
  1. Ouvrez un terminal dans VSCode (Ctrl+` ou Terminal → New Terminal)
  2. Lancez le serveur de prévisualisation :
  1. Ouvrez votre navigateur sur http://localhost:3000
Vos changements apparaissent en temps réel à mesure que vous modifiez les fichiers !

​
Étape 7 : Publier ses modifaications sur le Wiki

Gitkraken
  • 🟥 Rectangle rouge : fichiers modifiés (possibilité de voir les modifications en cliquant sur chaque fichier)
  • 🟦 Rectangle bleu : historique des dernières modifications (possibilité de voir les changements en cliquant sur chaque commit)
  1. Cliquez sur le WIP
  2. Cliquez sur Stage All Changes
  3. Mettez un titre à votre push (exemple : Ajout de la page[…], corrections des fautes d’orthographe,…)
  4. Cliquez sur Stage Changes to Commit
  5. Cliquez sur Push (la version sera automatiquement mise à jour sur le wiki)
Avant de faire des modifications, assurez-vous de faire un pull pour récupérer les dernières modifications du wiki. Cela évitera les conflits de fusion. Ouvrez gitkraken, cliquez sur le dépôt “docs”, puis cliquez sur “Pull” pour synchroniser votre copie locale avec le dépôt distant.

​
Conseils et Bonnes Pratiques

Commits fréquents

Faites des commits réguliers avec des messages clairs. C’est plus facile de corriger des erreurs.

Branche par modification

Créez une nouvelle branche pour chaque modification ou fonctionnalité.

Messages clairs

Décrivez ce que vous changez et pourquoi. Exemple: “Fix typo in rules” plutôt que “update”.

Prévisualisation

Utilisez toujours mint dev pour vérifier le rendu avant de proposer vos changements.

​
Problèmes fréquents

Assurez-vous que Git est bien installé et que vous avez redémarré votre terminal après l’installation.

Vérifiez que vous avez bien forké le dépôt et que vous êtes connecté à votre compte GitHub.

Si le dépôt original a changé, vous devrez peut-être mettre à jour votre fork. Demandez de l’aide sur Discord si cela arrive !

Assurez-vous d’être dans le bon dossier et que le port 3000 n’est pas déjà utilisé par une autre application.

​
Ressources Utiles

Documentation Mintlify

Apprenez-en plus sur les composants et fonctionnalités de Mintlify.

Guide Git interactif

Un jeu interactif pour apprendre Git de manière ludique.

Documentation VSCode

Maîtrisez votre éditeur de code.

Format Markdown

Maîtrisez le format Markdown.
Besoin d’aide ? N’hésitez pas à nous contacter sur Discord si vous êtes bloqué à une étape. La communauté est là pour vous aider !