- Recherche : recherche et analyse votre documentation existante, les dépôts connectés, le contexte pertinent et le web.
- Planifie : crée une liste de tâches structurée pour les travaux de documentation complexes.
- Rédige : génère ou met à jour du contenu en suivant les standards de rédaction et les bonnes pratiques.
- Valide : exécute les vérifications de l’Interface en ligne de commande (CLI) Mintlify pour s’assurer que la documentation se génère correctement.
- Publie les modifications : ouvre une pull request (demande de fusion) avec les modifications proposées pour relecture, ou pousse les modifications directement sur votre branche de déploiement, selon votre paramètre de processus de relecture.
Ce que vous pouvez faire avec l’agent
- Rédiger de nouveaux contenus à partir de vos prompts, pull requests (demandes de fusion), fils Slack ou pièces jointes.
- Mettre à jour la documentation existante pour de nouvelles fonctionnalités ou des évolutions d’API.
- Traiter et intégrer des images, des schémas et d’autres fichiers à partir des pièces jointes Slack.
- Rechercher et réviser des exemples de code et des références d’API dans l’ensemble de votre documentation.
- Référencer le code source de n’importe quel dépôt sur lequel la GitHub App Mintlify est installée.
- Récupérer du contexte en direct depuis des applications connectées comme Slack, Notion, Linear et Jira.
- Automatiser la maintenance de la documentation avec des automatisations.
- Répondre aux questions sur votre documentation et sur des sujets de rédaction technique.
- Traiter les retours de revue de code pour maintenir la qualité de la documentation.
- Capitaliser les connaissances issues des conversations Slack et des pull requests (demandes de fusion) avant qu’elles ne soient perdues.
- Naviguer et coordonner efficacement les modifications dans plusieurs fichiers et répertoires.
Connectez votre compte GitHub
Choisissez comment l’agent publie les modifications
- Create a pull request : L’agent pousse ses commits sur une nouvelle branche et ouvre une pull request contre votre branche de déploiement. Utilisez cette option lorsque vous souhaitez qu’une personne relise les modifications avant leur mise en ligne.
- Push to main : L’agent pousse ses commits directement sur votre branche de déploiement, et les modifications sont publiées dès que l’agent a terminé. Utilisez cette option lorsque vous faites confiance à l’agent pour publier sans relecture, par exemple sur un déploiement de staging.
Si votre branche de déploiement est protégée par des règles qui bloquent les push directs, le paramètre Review process est masqué et l’agent ouvre toujours une pull request.
Connecter des dépôts en tant que contexte
Utiliser des outils d’IA en complément de l’agent
Installer le skill Mintlify et les serveurs MCP pour les outils de codage assistés par IA.
Prochaines étapes
Connecter Slack
Ajoutez l’agent à votre espace de travail Slack.
Connecter des intégrations
Donnez à l’agent l’accès à Slack, Notion, Linear et d’autres outils.
Personnaliser le comportement
Configurez l’agent avec un fichier
AGENTS.md.Rédiger des prompts efficaces
Obtenez de meilleurs résultats grâce à des prompts ciblés.
Automatiser avec des automatisations
Automatisez les tâches récurrentes et la maintenance de la documentation à l’aide d’automatisations.