> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<div id="installing-the-github-app">
  ## Installation de l’application GitHub
</div>

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](https://dashboard.mintlify.com/settings/organization/github-app).

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

<Frame>
  <img className="h-80" alt="Page d’installation de l’application GitHub Mintlify avec l’option « Only select repositories » sélectionnée." src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/github/select-repos.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=8f413a4211d34bea933d0c3a30a945de" width="2980" height="1702" data-path="images/github/select-repos.png" />
</Frame>

<div id="permissions">
  ## Autorisations
</div>

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

<Info>
  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.
</Info>

<div id="managing-repository-access">
  ## Gestion de l’accès aux dépôts
</div>

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](https://github.com/apps/mintlify/installations/new).

<div id="configuring-docs-source">
  ## Configurer la source de la documentation
</div>

Modifiez l’organisation, le dépôt ou la branche à partir desquels votre documentation est générée dans la section [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) de votre tableau de bord.

<div id="troubleshooting">
  ## Dépannage
</div>

<div id="github-app-connection-issues">
  ### Problèmes de connexion de l’application GitHub
</div>

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

<Steps>
  <Step title="Désinstallez l’application Mintlify via GitHub.">
    1. Dans GitHub, allez aux [installations](https://github.com/settings/installations) et sélectionnez **Configure** à côté de l’application Mintlify. Faites défiler et sélectionnez **Uninstall**.
    2. Allez dans [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) et sélectionnez **Revoke** à côté de l’application Mintlify.
  </Step>

  <Step title="Réinstallez l’application Mintlify.">
    1. Dans votre tableau de bord Mintlify, allez dans [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) et installez l’application GitHub.
    2. Autorisez votre compte dans la section [My Profile](https://dashboard.mintlify.com/settings/account) de votre tableau de bord.
  </Step>
</Steps>

<div id="feedback-add-ons-are-unavailable">
  ### Les modules complémentaires de feedback ne sont pas disponibles
</div>

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.

<Steps>
  <Step title="Accéder aux paramètres Git">
    Accédez à [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) dans votre tableau de bord.
  </Step>

  <Step title="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é.

    <Frame>
      <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/github/revalidate-settings-light.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=6ffeaae9bd46019c4c35ff624c596fce" alt="La page Git Settings dans le tableau de bord Mintlify. Une flèche orange pointe vers la coche verte qui revalide les paramètres du dépôt." className="block dark:hidden" width="1996" height="1168" data-path="images/github/revalidate-settings-light.png" />

      <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/github/revalidate-settings-dark.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=10c47d78715e52c587dcf7332faaf5e7" alt="La page Git Settings dans le tableau de bord Mintlify. Une flèche orange pointe vers la coche verte qui revalide les paramètres du dépôt." className="hidden dark:block" width="1998" height="1170" data-path="images/github/revalidate-settings-dark.png" />
    </Frame>
  </Step>
</Steps>