Passer au contenu principal
Autopilot nécessite une offre Pro ou Enterprise.
Autopilot est un agent qui travaille en arrière-plan pour vous aider à maintenir votre documentation. Vous pouvez lui accorder un accès en lecture à vos dépôts de code et à d’autres outils pour l’aider à comprendre le workflow de votre équipe et vos besoins en contenu. Lorsqu’il détecte des modifications dans votre code, il ouvre des pull requests pour suggérer des mises à jour de votre documentation et identifie votre équipe pour qu’elle les relise. Autopilot est distinct des automatisations. Les automatisations exécutent des prompts spécifiques pour l’agent selon les déclencheurs que vous configurez. Autopilot décide seul de ce qui doit être mis à jour. Il vérifie quelles automatisations sont actives et évite de les dupliquer. Autopilot examine également vos automatisations configurées pour se constituer un contexte sur votre site et vos besoins en contenu. Par défaut, Autopilot suggère des mises à jour de votre documentation lorsque votre code change et exécute un contrôle qualité une fois par jour. Pour modifier ce sur quoi Autopilot travaille et quand il s’exécute, discutez avec Autopilot.

Prérequis

  • Un projet Mintlify connecté à un dépôt GitHub. Autopilot ne prend pas en charge GitLab ni d’autres fournisseurs Git.
  • L’application GitHub Mintlify installée sur votre dépôt de documentation et sur tous les dépôts de code source que vous souhaitez qu’Autopilot utilise.

Activer Autopilot

  1. Ouvrez la page Autopilot dans votre tableau de bord.
  2. Activez l’interrupteur de la carte Autopilot.
Lorsque vous activez Autopilot pour la première fois, il effectue une première vérification pour se constituer un contexte à partir de votre documentation, de vos dépôts et de vos outils connectés. Cela prend généralement quelques minutes. Une fois cette première vérification terminée, vous pouvez discuter avec Autopilot.

Connecter des dépôts et des outils

La section Integrations de la page Autopilot répertorie les sources qu’Autopilot lit pour comprendre comment votre équipe livre et ce que couvre votre documentation.

Dépôts GitHub

Si vous n’avez pas connecté GitHub, cliquez sur Connect dans la ligne GitHub pour installer l’application GitHub Mintlify. Pour choisir les dépôts qu’Autopilot utilise comme contexte :
  1. Cliquez sur Configure dans la ligne GitHub.
  2. Sous Additional repositories, sélectionnez les dépôts de code source que vous souhaitez qu’Autopilot utilise.
  3. Cliquez sur Save.
Votre dépôt de documentation est toujours inclus comme contexte obligatoire pour Autopilot. Vous ne pouvez donc pas le retirer. La liste Additional repositories n’affiche que les dépôts sur lesquels l’application GitHub Mintlify est installée. Pour ajouter un dépôt qui n’apparaît pas dans la liste, installez d’abord l’application GitHub sur celui-ci.

Slack et autres intégrations

Cliquez sur Connect dans la ligne Slack pour qu’Autopilot puisse se constituer un contexte à partir des conversations. Si vous déconnectez Slack depuis la page Autopilot, l’application Slack Mintlify est supprimée de votre espace de travail pour tous les produits qui l’utilisent, y compris les automatisations. La section répertorie également les intégrations partagées prises en charge et disponibles pour votre organisation, comme Linear, Jira, Notion, Confluence, PostHog, Zendesk, Intercom, Plain et Pylon. Autopilot lit celles que vous connectez comme contexte.

Comment Autopilot ouvre des pull requests

Autopilot commite ses modifications sur une nouvelle branche et ouvre une pull request. Il ne pousse jamais directement sur votre branche de déploiement ni sur la branche par défaut du dépôt. Par défaut, les pull requests ciblent votre branche de déploiement. Si votre équipe fusionne les modifications dans une branche différente de celle à partir de laquelle votre site est déployé, indiquez-le à Autopilot dans un chat, et il ciblera cette branche à la place.

Relecteurs et e-mails

Par défaut, Autopilot assigne chaque pull request au membre de l’équipe qu’il identifie comme responsable du code modifié, demande sa relecture et lui envoie un e-mail au sujet de la pull request. Pour demander des relectures à d’autres personnes ou changer qui relit les modifications, indiquez-le à Autopilot dans un chat. Autopilot envoie les e-mails depuis autopilot@mintlify.com. Ajoutez cette adresse à vos contacts pour éviter les filtres anti-spam. Autopilot n’envoie des e-mails qu’aux membres de votre organisation Mintlify ou à des adresses d’un domaine de messagerie d’entreprise utilisé par les membres de votre organisation.

Examiner les suggestions

Les pull requests ouvertes par Autopilot apparaissent sous Suggestions sur la page Autopilot de votre tableau de bord. Cliquez sur une suggestion pour l’ouvrir. Chaque suggestion affiche le titre de la pull request, le dépôt, la branche et les fichiers modifiés avec le nombre de lignes. Lorsqu’un déploiement de prévisualisation existe, cliquez sur Preview pour voir les modifications sur votre site.
  • Cliquez sur Accept pour fusionner la pull request.
  • Cliquez sur Close pour fermer la pull request sans la fusionner.
  • Envoyez un message pour demander des modifications. Autopilot met à jour la pull request.
Si une pull request présente des conflits de fusion ou si vos règles de protection de branche bloquent la fusion, résolvez-la sur GitHub.

Discuter avec Autopilot

Sur la page Autopilot, cliquez sur Chat to configure dans la carte Autopilot pour démarrer une conversation avec Autopilot dans le panneau de l’agent. Dans un chat, vous pouvez poser des questions sur le travail d’Autopilot, donner des instructions pour les travaux futurs et mettre en pause ou reprendre un type de travail. Lorsque vous reprenez un travail planifié, il s’exécute à sa prochaine heure planifiée. Voici quelques exemples de chats que vous pouvez avoir avec Autopilot :
  • Demander ce qu’Autopilot a fait et pourquoi, par exemple pourquoi il a ouvert une pull request précise.
  • Demander quand Autopilot s’exécute et quels dépôts et intégrations il utilise.
  • Demander à Autopilot de faire relire une pull request par un membre précis de l’équipe.
  • Demander à Autopilot d’exécuter une vérification hebdomadaire des liens cassés.
Les chats nécessitent le rôle d’éditeur ou d’administrateur. Vous ne pouvez pas démarrer un nouveau chat lorsqu’Autopilot est en pause.

Mettre Autopilot en pause

Pour mettre Autopilot en pause, désactivez l’interrupteur de la carte Autopilot. Lorsque vous réactivez Autopilot, il se constitue un contexte sur les modifications survenues pendant la pause, mais il ne crée pas de mises à jour pour celles-ci.

Pauses automatiques

Avant chaque exécution, Autopilot vérifie votre offre et vos crédits. Il se met lui-même en pause au lieu de s’exécuter dans l’un de ces cas :
  • Votre organisation n’a plus de crédits. Ajoutez des crédits, puis réactivez l’interrupteur.
  • Votre offre n’inclut plus Autopilot. Pour reprendre, passez à une offre qui inclut Autopilot.

Crédits

Chaque exécution d’Autopilot qui ouvre ou met à jour une pull request coûte 250 crédits. Les exécutions qui n’ouvrent ni ne mettent à jour de pull request ne coûtent aucun crédit. Consultez Tarification par crédits pour plus d’informations.