GitHub

Synchronisez votre documentation avec un dépôt GitHub

Mintlify utilise une application GitHub pour synchroniser automatiquement votre documentation avec votre dépôt GitHub.

​

Installation de l’application GitHub

Installez l’application GitHub Mintlify sur le compte ou l’organisation GitHub propriétaire de votre dépôt de documentation. Vous devez être propriétaire de l’organisation ou disposer des droits d’administrateur sur un dépôt pour installer l’application. Si vous n’avez pas les autorisations requises, le propriétaire du dépôt doit approuver la demande d’installation.

Installez l’application GitHub Mintlify depuis votre tableau de bord.

Nous recommandons d’accorder l’accès uniquement au dépôt où votre documentation est hébergée.

​

Autorisations

Lorsque vous installez l’application GitHub, il vous sera demandé d’accorder les autorisations suivantes :

Autorisations en lecture :

• metadata : Informations de base sur le référentiel

Autorisations en lecture et en écriture :

• checks : Créer des vérifications d’état sur les pull requests
• code : Lire les modifications de fichiers lorsque vous validez sur votre branche de documentation
• deployments : Générer des déploiements de prévisualisation pour les pull requests
• pull requests : Créer des branches et des pull requests depuis l’Éditeur web
• workflows : Gérer GitHub Actions pour les déploiements de la documentation

L’application n’accède qu’aux référentiels auxquels vous lui accordez explicitement l’accès. Si vous avez activé des règles de protection des branches, l’application ne peut pas pousser directement vers les branches protégées.

​

Gestion de l’accès aux dépôts

Lors de l’installation de notre application GitHub, vous pouvez accorder l’accès à tous vos dépôts ou uniquement à certains. Nous recommandons d’accorder l’accès uniquement aux dépôts qui contiennent votre documentation. Vous pouvez modifier ce choix à tout moment dans vos paramètres de l’application GitHub.

​

Configurer la source de la documentation

Modifiez l’organisation, le dépôt ou la branche à partir desquels votre documentation est générée dans la section Git Settings de votre tableau de bord.

​

Dépannage

​

Problèmes de connexion de l’application GitHub

Si vous rencontrez des problèmes avec l’application GitHub, réinitialiser la connexion permet de résoudre la plupart des cas.

1. Désinstallez l’application Mintlify via GitHub.

   1. Dans GitHub, allez aux installations et sélectionnez Configure à côté de l’application Mintlify. Faites défiler et sélectionnez Uninstall.
   2. Allez dans Authorized GitHub Apps et sélectionnez Revoke à côté de l’application Mintlify.
2. Réinstallez l’application Mintlify.

   1. Dans votre tableau de bord Mintlify, allez dans Git Settings et installez l’application GitHub.
   2. Autorisez votre compte dans la section My Profile de votre tableau de bord.

​

Les modules complémentaires de feedback ne sont pas disponibles

Si vous ne pouvez pas activer les options de suggestions d’édition ou de signalement de problèmes dans votre tableau de bord et que votre dépôt est public, revalidez vos paramètres Git.

1. Accéder aux paramètres Git

   Accédez à Git Settings dans votre tableau de bord.

2. Revalider vos paramètres

   Cliquez sur la coche verte dans le coin du bloc des paramètres Git pour revalider les paramètres de votre dépôt. Cela forcera la mise à jour des paramètres de votre dépôt afin d’indiquer s’il est public ou privé.