Suggestions de l'agent

Surveillez les dépôts Git pour les modifications et recevez des suggestions de mises à jour de la documentation.

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 à suggérer des mises à jour de la documentation à partir de deux sources.

• Modifications de pull request : Surveillez les dépôts Git sélectionnés pour détecter les changements de code nécessitant des mises à jour de la documentation.
• Conversations avec l’Assistant : Analysez les questions que les utilisateurs posent à l’assistant sur votre site de documentation pour identifier les lacunes de contenu.

Lorsque l’agent identifie des mises à jour potentielles de la documentation, il crée une suggestion dans votre Dashboard avec le contexte nécessaire pour créer une pull request (demande de fusion).

Utilisez les suggestions pour garder votre documentation à jour de manière proactive lorsque de nouvelles fonctionnalités sont déployées ou pour répondre aux questions fréquentes des utilisateurs.

​

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

Définissez quels référentiels l’agent surveille et comment vous recevez les notifications dans les paramètres de l’agent. La page des paramètres affiche toutes les organisations GitHub et tous les référentiels surveillés par l’agent.

Pour accéder aux paramètres de l’agent :

1. Cliquez sur le bouton Ask agent dans votre Dashboard pour ouvrir le panneau de l’agent.

2. Cliquez sur le bouton Settings.

   

​

Surveiller les référentiels

L’agent surveille la branche par défaut (généralement main) pour chaque référentiel pour lequel vous avez activé la surveillance. Un contrôle GitHub nommé Mintlify Autopilot s’exécute sur les pull requests (demandes de fusion) dans les référentiels surveillés afin de les analyser et d’identifier d’éventuelles mises à jour de la documentation. Lorsque vous fusionnez une pull request qui nécessite des mises à jour de la documentation, l’agent crée une suggestion dans votre Dashboard.

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.

Si vous désactivez la surveillance, l’agent cesse 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.

​

Analyses des conversations

Activez les analyses des conversations pour recevoir des suggestions fondées sur les questions fréquentes que les utilisateurs posent à l’Assistant.

Lorsque cette option est activée, l’agent analyse périodiquement les conversations avec l’Assistant et génère des suggestions lorsqu’il identifie des tendances dans les questions qui révèlent une documentation manquante ou peu claire.

​

Notifications

Les suggestions de l’agent apparaissent toujours dans votre Dashboard. Vous pouvez configurer les notifications pour recevoir des e-mails ou des messages directs Slack lorsque l’agent crée de nouvelles suggestions.

Si vous ne recevez pas les notifications par e-mail relatives aux suggestions, vérifiez votre dossier de courrier indésirable et ajoutez l’adresse e-mail [e-mail] à votre liste d’expéditeurs autorisés.

​

Examiner les suggestions

L’agent crée des suggestions dans votre Dashboard. Chaque suggestion affiche l’intitulé de la pull request (demande de fusion) ou le sujet de conversation de l’Assistant qui a déclenché la suggestion, la date de création 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.

​

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.