Suggestions de l’agent

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

Les suggestions de l’agent sont disponibles avec 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 des pull requests (demandes de fusion) : Surveillez des 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 afin d’identifier les lacunes dans la documentation.

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.

​

Prérequis

Avant de pouvoir utiliser les suggestions, vous devez installer la Mintlify GitHub App dans 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.

​

Configurer les suggestions

Dans les paramètres de l’agent, configurez les dépôts que l’agent surveille et la manière dont vous recevez les notifications. La page des paramètres affiche toutes les organisations et tous les dépôts GitHub 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 toutes les pull requests (demandes de fusion) fusionnées pour chaque référentiel que vous activez, quelle que soit la branche dans laquelle elles sont fusionnées. Une vérification GitHub nommée Mintlify Autopilot s’exécute sur les pull requests dans les référentiels surveillés afin de les analyser et de détecter 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 se peut que plusieurs suggestions apparaissent immédiatement après l’activation de la surveillance.

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

​

Analyses des conversations

Si vous avez accès à l’agent et à l’Assistant, l’agent génère des suggestions à partir des conversations que vos utilisateurs ont avec l’Assistant.

L’agent analyse régulièrement les conversations de l’Assistant et crée des suggestions lorsqu’il identifie des tendances dans les questions indiquant des lacunes ou un manque de clarté dans la documentation.

​

Notifications

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

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

​

Examiner les suggestions

L’agent crée des suggestions dans votre Dashboard. Chaque suggestion indique la pull request (demande de fusion) ou la conversation avec l’Assistant qui l’a déclenchée, sa 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 (demandes de fusion)

Ajoutez des suggestions comme context pour permettre à l’agent de créer des pull requests (demandes de fusion).

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 la demande à l’agent pour ouvrir une pull request (demande de fusion).

​

Ignorer une suggestion

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 retirer 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 toute suggestion que vous souhaitez ignorer.

La suggestion est immédiatement supprimée de votre Dashboard. Vous ne pouvez pas récupérer les suggestions ignorées.