Passer au contenu principal
Si le propriétaire de votre espace de travail Slack exige l’approbation d’un administrateur pour installer des applications, demandez-lui d’approuver l’application Mintlify avant de la connecter.

​
Connectez votre espace de travail Slack

  1. Accédez à la page Agent de votre Dashboard.
  2. Dans la section “Agent settings”, cliquez sur Install Slack app.
La section des paramètres d'application avec les boutons d'installation de Slack, Linear et Notion.
  1. Suivez les instructions Slack pour installer l’application mintlify dans votre espace de travail.
  2. Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack.
  3. 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.
Si votre organisation dispose de plusieurs déploiements, l’agent vous demande de choisir avec quel déploiement travailler la première fois que vous envoyez une demande.Votre déploiement préféré est propre à votre compte Slack et n’affecte pas les autres membres de l’équipe. Vous pouvez passer à un autre déploiement à tout moment pendant une conversation en cliquant sur le bouton Switch deployment dans le message de statut de l’agent dans le fil. L’agent conserve votre historique de conversation afin que vous puissiez reprendre là où vous en étiez avec le nouveau déploiement.

​
Utiliser l’agent dans Slack

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.
  • Partager des liens de pull request (demandes de fusion) avec l’agent pour mettre à jour la documentation associée.

​
Mettre à jour la documentation

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 fichiers de code ou d’autres documents avec votre message. L’agent les traite automatiquement et les inclut dans votre documentation.
L’agent lit le contexte de la demande ou du fil et crée une pull request (demande de fusion) dans votre référentiel connecté avec les mises à jour.

​
Référencer d’autres dépôts

L’agent peut lire le code source de n’importe quel dépôt sur lequel la GitHub App Mintlify est installée, 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 ouvre toujours des pull requests (demandes de fusion) sur votre dépôt de documentation.

​
Suivez la progression en temps réel

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) et un lien pour ouvrir les modifications dans l’éditeur web.

​
Bonnes pratiques

  • 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.

Sujets connexes

Ajouter l'agent à LinearQu'est-ce que l'agent ?Personnaliser le comportement de l'agent