Passer au contenu principal
Autopilot est disponible sur les offres Custom. Pour activer Autopilot pour votre organisation, contactez notre équipe commerciale.
Autopilot surveille les dépôts Git que vous avez sélectionnés et suggère des mises à jour de la documentation. Autopilot signale les modifications potentiellement visibles par les utilisateurs dans votre application et prépare le contexte pour que l’agent rédige une pull request (demande de fusion) visant à mettre à jour votre documentation. Utilisez Autopilot pour garder votre documentation à jour de manière proactive lorsque de nouvelles fonctionnalités ou mises à jour sont déployées.

Prérequis

Avant d’utiliser autopilot, vous devez installer la Mintlify GitHub App au sein de votre organisation. L’application doit avoir accès à votre référentiel de documentation et à au moins un autre référentiel où les modifications de code nécessitent des mises à jour de la documentation.

Accéder à Autopilot

Accédez à la page Autopilot sur votre Dashboard pour afficher les suggestions et configurer la surveillance de votre référentiel. La page Autopilot affiche les suggestions en attente qui nécessitent votre revue et donne accès aux paramètres de configuration.

Configurer autopilot

Configurez les paramètres d’autopilot depuis la page autopilot en cliquant sur le bouton Configuration.
La page de configuration d'autopilot en mode clair.
La page de configuration affiche toutes les organisations GitHub dans lesquelles vous avez installé la GitHub App Mintlify, ainsi que les dépôts surveillés par autopilot.

Sélectionner les référentiels à surveiller

Après avoir installé la Mintlify GitHub App sur vos organisations, vous pouvez sélectionner les référentiels à surveiller.
  1. Accédez à la page des paramètres d’Autopilot.
  2. Trouvez l’organisation GitHub à laquelle appartient le référentiel que vous souhaitez surveiller.
  3. Cliquez sur l’icône d’engrenage à côté du nom de l’organisation.
    L'icône d'engrenage à côté du nom de l'organisation en mode clair.
  4. Activez le bouton à bascule à côté de chaque référentiel que vous souhaitez surveiller.
  5. Utilisez la barre de recherche pour filtrer les référentiels par nom.
  6. Cliquez sur Tout activer ou Tout désactiver pour configurer rapidement tous les référentiels.
Autopilot surveille la branche par défaut (généralement main) de chaque référentiel. Lorsqu’une pull request (demande de fusion) est fusionnée dans cette branche, Autopilot analyse les changements et propose des suggestions.

Arrêter de surveiller un référentiel

  1. Accédez à la page des paramètres Autopilot.
  2. Trouvez l’organisation GitHub à laquelle appartient le référentiel que vous souhaitez arrêter de surveiller.
  3. Cliquez sur l’icône d’engrenage à côté du nom de l’organisation.
    L’icône d’engrenage à côté du nom de l’organisation en mode clair.
  4. Désactivez le bouton à bascule à côté du référentiel que vous souhaitez arrêter de surveiller.
  5. Utilisez la barre de recherche pour filtrer les référentiels par nom.
Autopilot arrête immédiatement de surveiller le référentiel. Toutes les suggestions existantes pour ce référentiel restent dans votre Dashboard jusqu’à ce que vous les rejetiez.

Examiner les suggestions

Lorsque Autopilot détecte des modifications visibles par les utilisateurs dans vos référentiels surveillés, il crée des suggestions qui apparaissent dans votre Dashboard. Chaque suggestion affiche le titre de la pull request, le nom du référentiel, un résumé expliquant pourquoi la modification peut nécessiter une mise à jour de la documentation, ainsi que la date de création de la suggestion.

Appliquer des suggestions

Lorsque vous appliquez une suggestion, Autopilot ouvre le panneau agent avec du contexte sur la pull request (demande de fusion). L’agent reçoit l’URL de la pull request et un résumé des fichiers modifiés.
  1. Accédez à la page Autopilot dans votre Dashboard.
  2. Cliquez sur Apply suggestion.
  3. Utilisez l’interface de l’agent pour affiner les propositions de mise à jour de la documentation ou créer une pull request (demande de fusion).

Ignorer des suggestions

Si une suggestion ne nécessite pas de mise à jour de la documentation ou si vous avez déjà effectué les modifications, ignorez-la pour la retirer de votre Dashboard.
  1. Accédez à la page Autopilot depuis votre Dashboard.
  2. Cliquez sur Dismiss.
La suggestion est immédiatement supprimée de votre liste affichée. Vous ne pouvez pas récupérer les suggestions ignorées.