Ajouter l'agent à Slack

Utilisez l’agent dans Slack pour mettre à jour votre contenu, poser des questions et capturer les connaissances de l’équipe. Mentionnez l’agent dans un canal pour l’utiliser de manière collaborative, ou envoyez-lui un message direct pour l’utiliser en privé. Les conversations avec l’agent dans Slack sont gratuites et ne comptent pas dans le solde de crédits de votre organisation.

1. Accédez à la page Agent de votre Dashboard.
2. Dans la section “Agent settings”, cliquez sur Install Slack app.
3. Suivez les instructions Slack pour installer l’application mintlify dans votre espace de travail.
4. Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack.
5. Vérifiez que l’agent fonctionne et répond lorsque vous :
   • Envoyez un message direct à l’agent.
   • Mentionnez l’agent avec @mintlify dans un canal.

Pour supprimer l’agent de votre workspace Slack :

1. Ouvrez la page Automatisations dans votre dashboard.
2. Cliquez sur Disconnect Slack pour révoquer la connexion entre Mintlify et votre workspace.
3. Dans Slack, ouvrez Settings & administration > Manage apps, trouvez l’application mintlify et cliquez sur Remove.

Après la déconnexion, l’agent cesse de répondre aux mentions et aux messages directs, et les automatisations qui publient dans Slack cessent de délivrer des notifications. Reconnectez-le à tout moment en suivant les étapes de Connectez votre espace de travail Slack. Si vous devez réautoriser l’agent — par exemple, pour accorder de nouvelles permissions après une mise à jour des scopes Slack ou pour récupérer après la révocation d’un jeton — réinstallez l’application depuis votre dashboard Mintlify. Lorsque vous réinstallez l’agent dans un espace de travail déjà connecté à votre organisation, Mintlify met à jour le bot token stocké sur place. Vos canaux et fils de discussion existants restent intacts. Une fois connecté, vous pouvez :

• Envoyer des messages directs à l’agent pour l’utiliser en privé afin de mettre à jour votre documentation.
• Mentionner @mintlify dans un canal pour l’utiliser publiquement et de manière collaborative.
• Joindre des fichiers et des images directement à vos messages pour que l’agent les analyse et les intègre à votre documentation.
• Poursuivre les conversations dans des fils pour affiner les modifications ou poser des questions de suivi. L’agent réutilise les fichiers, images et réactions emoji partagés plus tôt dans le fil comme contexte pour les demandes suivantes, vous n’avez donc pas besoin de les téléverser à nouveau.
• Partager des liens de pull request (demandes de fusion) avec l’agent pour mettre à jour la documentation associée.

Posez à l’agent des questions sur votre produit ou votre documentation et recevez les réponses dans le fil.

• Nouvelle question : Envoyez un message direct à l’agent ou mentionnez @mintlify dans un canal avec votre question.
• Fil existant : Répondez dans le fil et mentionnez @mintlify avec une question de suivi.

Exemples de questions :

• « Quelles pages mentionnent la limite de débit de l’API ? »
• « Comment configurer l’authentification ? »
• « Comment est structurée notre navigation ? »

L’agent Slack peut utiliser les applications tierces connectées comme outils en lecture seule lorsqu’il répond aux questions ou met à jour votre documentation.

• Les intégrations partagées sont disponibles pour toute l’organisation.
• Les intégrations personnelles utilisent le compte connecté par la personne qui discute avec l’agent.

Vous n’avez pas à sélectionner les intégrations pour chaque conversation. Mentionnez naturellement l’application dans votre demande, par exemple : « Compare ce ticket Linear avec le plan de lancement dans mon Google Drive. » Si une application n’est pas connectée, demandez à l’agent de la connecter. Suivez le lien d’autorisation qu’il renvoie, puis envoyez un autre message dans le même fil pour qu’il confirme la connexion. Consultez Intégrations pour les applications prises en charge, les portées de connexion et les autorisations. Utilisez l’agent pour mettre à jour votre documentation au moyen d’une nouvelle demande ou dans un fil existant.

• Nouvelle demande : Envoyez un message direct à l’agent ou mentionnez @mintlify dans un canal avec des instructions sur ce qu’il faut mettre à jour.
• Fil existant : Répondez dans le fil et mentionnez @mintlify avec des instructions sur ce qu’il faut mettre à jour.
• Avec des pièces jointes : Téléversez des images, des diagrammes, des PDF, des SVG, des fichiers de code ou d’autres documents avec votre message. L’agent les traite automatiquement et les inclut dans votre documentation. Dans un fil, l’agent a accès aux images et fichiers partagés dans les messages précédents, vous pouvez donc y faire référence dans les demandes suivantes sans avoir à les téléverser à nouveau.

L’agent lit le contexte de la demande ou du fil et met à jour votre référentiel connecté. Selon votre paramètre de processus de relecture, l’agent ouvre une pull request (demande de fusion) ou pousse les modifications directement sur votre branche de déploiement. Demandez à l’agent de cibler une branche spécifique si vous voulez que les modifications atterrissent ailleurs que sur votre branche de déploiement. Par exemple, « ouvre la PR contre la branche staging » ou « pousse ces commits sur docs-refresh ». L’agent crée la pull request sur la branche que vous nommez, ou pousse les commits directement dessus lorsque la branche existe déjà. Lorsqu’une automatisation publie une notification Slack au sujet d’une pull request qu’elle a ouverte, répondez dans ce fil et mentionnez @mintlify pour poursuivre le travail. L’agent reprend l’ensemble du contexte de l’exécution, effectue un checkout de la même branche et publie vos modifications sous forme de commits de suivi sur la même pull request, plutôt que d’en ouvrir une nouvelle. Vous pouvez également partager un lien vers n’importe quelle pull request Mintlify directement avec l’agent pour la poursuivre depuis un nouveau fil. Lorsqu’une automatisation de modification de code ouvre une pull request de documentation, elle publie un commentaire sur la pull request de code déclenchante en lien avec la pull request de documentation créée, et attribue un relecteur en essayant l’auteur puis les committers de la pull request de code, dans l’ordre, jusqu’à ce que l’un accepte. L’agent Slack et les Automatisations utilisent tous deux l’agent Mintlify. Demandez à l’agent de créer, configurer, exécuter ou dépanner n’importe quelle automatisation. Il peut effectuer toutes les actions dont vous disposez sur la page Automations de votre dashboard. Exemples de prompts :

• « Crée une automatisation qui rédige une entrée de changelog chaque fois que nous fusionnons sur main. »
• « Mets en place une automatisation qui met à jour la documentation dès qu’un ticket Jira est fermé. »
• « Désactive l’automatisation hebdomadaire du changelog. »
• « Exécute l’automatisation de modification de code sur la PR #123. »
• « Passe en revue les fusions du mois dernier et mets à jour le changelog. »

Vous pouvez également interroger l’agent sur l’activité des automatisations, comme les exécutions récentes, les échecs ou l’utilisation des crédits.

• « Comment puis-je rendre mes automatisations plus économes en crédits ? »
• « Pourquoi la dernière exécution de l’automatisation de modification de code a-t-elle échoué ? »

​

Déclencher des automatisations depuis des messages Slack

Vous pouvez configurer une automatisation personnalisée pour qu’elle s’exécute lorsqu’une personne publie un message de premier niveau dans un canal Slack choisi. L’agent lit chaque message, décide s’il justifie une mise à jour de la documentation et ouvre une pull request lorsque c’est le cas. Configurez cela lorsque vous créez ou modifiez l’automatisation sur la page Automations. L’application mintlify doit être membre du canal choisi. Invitez-la avec /invite @mintlify avant d’enregistrer l’automatisation. L’agent peut lire le code source de n’importe quel dépôt connecté via la GitHub app ou l’intégration GitLab, même s’il ne s’agit pas de votre dépôt de documentation. Cela lui permet de construire un contexte plus approfondi pour guider les mises à jour de la documentation. Lorsque vous mentionnez un autre dépôt dans votre demande, l’agent le clone à la demande et examine les fichiers pertinents avant de rédiger les modifications. Exemples de prompts :

• « Mettez à jour le guide d’authentification en fonction des changements dans acme/api-server/src/auth.ts. »
• « Documentez les nouveaux endpoints ajoutés dans acme/backend#1234. »
• « À quels dépôts avez-vous accès ? »

Les dépôts clonés sont en lecture seule. L’agent les utilise comme contexte, mais n’écrit des modifications que dans votre dépôt de documentation. Pendant que l’agent travaille sur votre demande, il fournit un retour en direct dans le fil Slack.

• Mises à jour de statut : Un message mis à jour en direct indique ce que l’agent est en train de faire, comme le nombre de fichiers qu’il a recherchés, lus et modifiés.
• Progression des tâches : Lorsque l’agent décompose votre demande en plusieurs tâches, il affiche une liste de contrôle pour que vous puissiez suivre la progression de chacune.
• Questions : Si l’agent a besoin de plus d’informations, il présente des options parmi lesquelles vous pouvez choisir ou vous pouvez répondre dans le fil avec une réponse personnalisée.
• Interruptions : Si vous envoyez un message de suivi pendant que l’agent travaille encore, il arrête la tâche en cours et commence la nouvelle.
• Achèvement : Lorsque l’agent a terminé, il publie un résumé avec un lien vers la pull request (demande de fusion) ou le commit et un lien pour ouvrir les modifications dans l’éditeur web.

Les capacités de l’agent dans Slack correspondent au rôle du compte Mintlify associé :

• Administrateurs et éditeurs : Peuvent poser des questions et apporter des modifications à la documentation. L’agent a accès aux outils d’édition de fichiers et de pull requests.
• Lecteurs : Peuvent uniquement poser des questions. L’agent fonctionne toujours en mode lecture seule pour les outils Mintlify, quelle que soit la demande.

Pour modifier les autorisations d’un coéquipier, mettez à jour son rôle depuis la page Members de votre Dashboard.

​

Utiliser l’agent dans le panneau latéral Slack

Discutez avec @mintlify dans le panneau latéral Slack pour poser des questions ou demander des mises à jour de la documentation sans publier dans un canal. L’agent du panneau latéral se comporte comme l’agent Slack : mêmes autorisations, mêmes outils et même processus de revue pour les modifications qu’il apporte.

• Soyez précis : Indiquez exactement à l’agent ce que vous souhaitez documenter et où cela doit être ajouté.
• Ajoutez du contexte : Si un fil de discussion ne contient pas toutes les informations nécessaires, ajoutez des détails supplémentaires dans votre message à l’agent.
• Relisez attentivement : Vous devez toujours relire les pull requests (demandes de fusion) créées par l’agent avant de les fusionner.