Passer au contenu principal
Les suggestions de l’agent sont disponibles dans les offres Custom. Pour activer les suggestions pour votre organisation, contactez notre équipe commerciale.
Vous pouvez autoriser l’agent à surveiller vos dépôts Git sélectionnés et à suggérer des mises à jour de la documentation. Lorsque l’agent identifie des changements potentiellement visibles par les utilisateurs dans votre application, il prépare le contexte nécessaire pour que vous puissiez créer une pull request (demande de fusion) afin de mettre à jour votre documentation en un clic. Utilisez les suggestions pour garder votre documentation à jour de manière proactive lorsque de nouvelles fonctionnalités ou mises à jour sont déployées.

​
Conditions requises

Avant de pouvoir utiliser les suggestions, 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 une mise à jour de la documentation.

​
Configurer les suggestions

Configurez les dépôts pour lesquels l’agent doit proposer des suggestions dans les paramètres de l’agent. La page de configuration affiche toutes les organisations GitHub dans lesquelles vous avez installé la GitHub App Mintlify, ainsi que les dépôts que l’agent surveille.

​
Sélectionner les référentiels à surveiller

Après avoir installé la GitHub App Mintlify au sein de vos organisations, sélectionnez les référentiels à surveiller.
  1. Cliquez sur le bouton Ask agent dans votre Dashboard pour ouvrir le panneau de l’agent.
  2. Cliquez sur le bouton Settings.
    Le bouton des paramètres en mode clair.
  3. Dans la section Monitor Repositories, cliquez sur le nom de l’organisation qui contient les référentiels que vous souhaitez surveiller.
  4. Activez le commutateur à côté de chaque référentiel que vous souhaitez surveiller, ou cliquez sur Enable all pour surveiller tous les référentiels de l’organisation.
L’agent surveille la branche par défaut (généralement main) pour chaque référentiel. Lorsqu’une pull request (demande de fusion) est fusionnée dans cette branche, l’agent analyse les modifications et crée des suggestions.
Lorsque vous activez pour la première fois la surveillance d’un référentiel, l’agent crée des suggestions pour les pull requests fusionnées au cours des sept derniers jours. Ce traitement rétroactif n’a lieu que si aucune suggestion n’existe déjà pour ce référentiel. Il est possible que plusieurs suggestions apparaissent immédiatement après l’activation de la surveillance.

​
Arrêter le suivi d’un référentiel

  1. Cliquez sur le bouton Ask agent dans votre Dashboard pour ouvrir le panneau de l’agent.
  2. Cliquez sur le bouton Settings.
    Le bouton des paramètres en mode clair.
  3. Dans la section Monitor Repositories, cliquez sur le nom de l’organisation qui contient les référentiels dont vous voulez arrêter le suivi.
  4. Désactivez le bouton bascule à côté du référentiel dont vous voulez arrêter le suivi, ou cliquez sur Disable all pour arrêter le suivi de tous les référentiels de l’organisation.
L’agent arrête immédiatement de suivre le référentiel. Toutes les suggestions existantes pour ce référentiel restent dans votre Dashboard jusqu’à ce que vous les ignoriez.

​
Examiner les suggestions

Lorsque l’agent 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 l’intitulé de la pull request (demande de fusion), le nom du référentiel, la date de création de la suggestion et les mises à jour de documentation proposées. Le bouton Ask agent dans votre Dashboard affiche le nombre de suggestions en attente de votre examen.
Le bouton Ask agent affichant quatre suggestions en mode clair.

​
Créer des pull requests

Ajoutez des suggestions comme contexte pour que l’agent puisse créer des pull requests.
  1. Cliquez sur le bouton Ask agent dans votre Dashboard pour ouvrir le panneau de l’agent.
  2. Cliquez sur Add to chat.
  3. Envoyez le prompt à l’agent pour qu’il ouvre 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à appliqué les modifications, ignorez-la pour la supprimer de votre Dashboard.
  1. Cliquez sur le bouton Ask agent dans votre Dashboard pour ouvrir le panneau de l’agent.
  2. Cliquez sur le bouton Dismiss à côté de chaque suggestion que vous souhaitez ignorer.
La suggestion est immédiatement supprimée de votre Dashboard. Vous ne pouvez pas restaurer les suggestions ignorées.