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
- Ouvrez le panneau de l’agent dans votre Dashboard.
-
Cliquez sur le bouton Settings.
- Dans la section d’intégration à Slack, cliquez sur Connect.
-
Suivez les instructions Slack pour ajouter l’application
mintlifyà votre espace de travail. - Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack.
-
Vérifiez que l’agent fonctionne et répond lorsque vous :
- Lui envoyez un message direct.
- Le mentionnez avec
@mintlifydans un canal.
Utiliser l’agent dans Slack
- Envoyer des messages directs à l’agent pour l’utiliser en privé afin de mettre à jour votre documentation.
- Mentionner
@mintlifydans un canal pour l’utiliser publiquement et de manière collaborative. - 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
- Nouvelle demande : Envoyez un message direct à l’agent ou mentionnez
@mintlifydans un canal avec des instructions sur ce qu’il faut mettre à jour. - Fil existant : Répondez dans le fil et mentionnez
@mintlifyavec des instructions sur ce qu’il faut mettre à jour.
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.