Passer au contenu principal
L’agent est disponible sur les offres Pro et Custom pour toute personne disposant d’un accès à votre Dashboard.
L’agent crée des pull requests (demandes de fusion) avec des modifications proposées pour votre documentation à partir de vos instructions. Lorsque vous envoyez une requête à l’agent, il consulte votre documentation, les dépôts connectés et les messages Slack pour créer du contenu qui suit les bonnes pratiques de rédaction technique et respecte le schéma Mintlify. Accédez à l’agent directement depuis votre Dashboard, dans votre espace de travail Slack, ou intégrez-le dans des applications personnalisées avec l’API. Utilisez l’agent pour :
  • Rédiger du nouveau contenu à partir de vos instructions, de liens vers des pull requests ou de fils de discussion Slack
  • Réviser des exemples de code obsolètes et des références d’API
  • Rechercher et mettre à jour le contenu existant
  • Répondre à des questions sur votre documentation et des sujets de rédaction technique

​
Utiliser l’agent dans le Dashboard

Accédez à l’agent depuis votre Dashboard à l’aide du raccourci clavier ⌘+I (macOS) ou Ctrl+I (Windows/Linux), ou en cliquant sur le bouton Ask agent. Le panneau de l’agent est redimensionnable sur ordinateur. Sur les appareils mobiles, l’agent s’ouvre en plein écran. Le panneau de l’agent comporte trois vues.
  • Chat : Envoyez des requêtes à l’agent pour mettre à jour votre documentation. L’agent crée des pull requests (demandes de fusion) en fonction de vos instructions et affiche des liens pour consulter les pull requests ou ouvrir les modifications dans l’éditeur web.
  • History : Parcourez les conversations passées et continuez à travailler sur des demandes précédentes. Cliquez sur une conversation pour la charger dans la vue Chat.
  • Settings : Configurez les intégrations de l’agent et l’accès au référentiel.

​
Ajouter l’agent à votre espace de travail Slack

Utilisez l’agent dans Slack pour collaborer avec votre équipe sur les mises à jour de la documentation.
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.
  1. Ouvrez le panneau de l’agent dans votre Dashboard.
  2. Cliquez sur le bouton Settings.
    Le bouton des paramètres en mode clair.
  3. Dans la section d’intégration à Slack, cliquez sur Connect.
  4. Suivez les invites Slack pour ajouter l’application mintlify à votre espace de travail.
  5. Suivez les invites Slack pour lier votre compte Mintlify à votre espace de travail Slack.
  6. Vérifiez que l’agent fonctionne correctement et répond lorsque :
    • Vous lui envoyez un message direct.
    • Vous le mentionnez avec @mintlify dans un canal.

​
Connectez votre compte GitHub

Par défaut, l’agent ouvre des pull requests au nom du bot Mintlify. Pour que les pull requests vous soient attribuées, connectez votre compte GitHub sur la page My profile du Dashboard.

​
Connecter des dépôts comme contexte

L’agent ne peut accéder qu’aux dépôts que vous connectez via l’application GitHub Mintlify. Configurez les dépôts auxquels l’agent peut accéder dans le panneau Settings de l’agent ou dans les paramètres de la GitHub App.

​
Personnaliser le comportement de l’agent

Ajoutez un fichier AGENTS.md dans votre référentiel pour personnaliser le comportement de l’agent. L’agent lit ce fichier et applique toutes les instructions que vous y fournissez. Créez le fichier AGENTS.md à la racine de votre référentiel. Si votre projet est un monorepo, créez le fichier à la racine du répertoire de documentation. Ajoutez toutes les instructions que vous souhaitez que l’agent suive. L’agent ajoute ces instructions à son prompt système, de sorte qu’elles influencent l’ensemble de ses réponses et de ses actions.
Examples of custom instructions
Toujours utiliser TypeScript pour les exemples de code. Ne jamais utiliser JavaScript.

Lors de la documentation des points de terminaison API, inclure les informations de limitation de débit.

Utiliser le format ISO 8601 (AAAA-MM-JJ) pour les dates.
L’agent applique ces instructions à toutes les tâches, que vous l’utilisiez depuis le Dashboard, dans Slack ou via l’API.

​
Intégrer l’agent via l’API

Utilisez les endpoints de l’agent pour créer des tâches, récupérer une tâche spécifique et récupérer toutes les tâches. Lors de la création de tâches via l’API, vous pouvez contrôler si des pull requests (demandes de fusion) sont créées en mode brouillon à l’aide du paramètre asDraft (dont la valeur par défaut est true). Définissez asDraft: false pour créer des pull requests (demandes de fusion) non brouillon, prêtes pour une revue immédiate et une fusion immédiates dans des workflows automatisés.

​
Rédiger des prompts efficaces

Considérez l’agent comme un assistant utile qui a besoin de vos indications pour accomplir des tâches. Donnez-lui des instructions claires et du contexte. Les tâches plus ciblées sont plus faciles à réaliser : décomposez donc les projets complexes en étapes plus petites. Formulez des prompts spécifiques et orientés vers les résultats. Des prompts génériques comme @mintlify Improve the onboarding page appliquent les bonnes pratiques générales, mais peuvent ne pas améliorer le contenu de la manière précise que vous aviez en tête. Essayez des prompts fondés sur les résultats que vous souhaitez que vos utilisateurs atteignent ou sur les problèmes qu’ils rencontrent. Par exemple :
  • @mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI
  • @mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key
Utilisez des prompts plus larges pour la maintenance générale du contenu, comme corriger les fautes de frappe, mettre à jour les redirections ou renommer une fonctionnalité dans l’ensemble de votre documentation. Par exemple :
  • @mintlify Find and fix all typos in the docs
  • @mintlify change all unordered lists to use * instead of -

​
Spécifier un nom de domaine

Si vous avez plusieurs sites de documentation, incluez le paramètre subdomain dans votre message pour indiquer sur quel ensemble de documentation l’agent doit travailler. Pour trouver votre nom de domaine, regardez l’URL de votre tableau de bord pour l’ensemble de documentation que vous souhaitez mettre à jour. Le nom de domaine est la dernière partie après le nom de votre organisation. Par exemple, si l’URL de votre tableau de bord est https://dashboard.mintlify.com/org-name/domain-name, votre nom de domaine est domain-name. Utilisez le format @mintlify subdomain=<your-domain-name> <your-prompt> pour demander à l’agent de travailler sur un ensemble de documentation spécifique. Exemples :
  • @mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR : demande à l’agent de mettre à jour le quickstart uniquement sur le site public-docs.
  • @mintlify subdomain=customer-docs Update the auth docs for the new authentication method : demande à l’agent de mettre à jour la documentation d’authentification uniquement sur le site customer-docs.

​
Workflows de l’agent

L’agent prend en charge de nombreuses tâches liées à la documentation. Ces workflows illustrent différentes manières d’intégrer l’agent à votre processus de documentation. Adoptez une approche qui correspond au fonctionnement actuel de votre équipe et adaptez-la à vos besoins spécifiques.

​
Itérer sur une invite dans un fil Slack

Envoyez une invite à l’agent, puis continuez à le mentionner avec @mintlify dans le même fil pour affiner et itérer sur la pull request (demande de fusion) qu’il crée. Par exemple : @mintlify Notre page de démarrage rapide a besoin d’une nouvelle section sur l’invitation de collaborateurs. Puis : @mintlify La nouvelle section devrait s’appeler "Inviter des collaborateurs". Suivi de toute autre itération.

​
Commencez avec l’agent, terminez manuellement

Demandez à l’agent de lancer un projet, puis basculez vers la branche qu’il crée et terminez la tâche dans votre environnement local ou dans l’éditeur web. L’agent peut vous aider à démarrer, puis vous pouvez prendre le relais pour finaliser la tâche. Par exemple : @mintlify Update the quickstart page to include information about inviting collaborators puis basculez sur la branche pour apporter des modifications supplémentaires avec votre méthode préférée.

​
Mettre à jour la documentation lors de la fusion de changements de fonctionnalité

Lorsque vous fusionnez une pull request de fonctionnalité, partagez le lien de la PR avec l’agent pour mettre à jour la documentation concernée. Par exemple : @mintlify Cette PR ajoute une nouvelle méthode d’authentification. Mettez à jour la doc pour inclure le nouveau flux d’authentification : [lien de la PR].

​
Générer des notes de version à partir d’une pull request (demande de fusion)

Demandez à l’agent de générer, à partir d’une pull request donnée, des notes de version ou de mettre à jour le journal des modifications en se basant sur l’historique des commits. Par exemple : @mintlify Generate release notes for this PR: [PR link].

​
Générer des exemples de code

Demandez à l’agent de générer des exemples de code pour des fonctionnalités dans toute votre documentation ou sur des pages spécifiques. Par exemple : @mintlify Génère un exemple de code pour rendre la méthode d’authentification plus facile à comprendre.

​
Passer en revue le contenu existant

Demandez à l’agent de vérifier le contenu existant pour en évaluer l’exactitude technique, le style, la grammaire ou d’autres problèmes. Par exemple : @mintlify Review the API rate limiting section. We changed limits last month.

​
Répondre aux retours des utilisateurs

Transmettez à l’agent les retours de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation. Par exemple : @mintlify Les utilisateurs se perdent à l’étape 3 du guide d’installation. Qu’est-ce qui pourrait la rendre peu claire ?.

​
Automatisez avec l’API

Intégrez l’agent à vos outils d’automatisation existants pour mettre automatiquement à jour la documentation lors de modifications du code, déclencher des relectures de contenu ou synchroniser les mises à jour de la documentation entre plusieurs dépôts. Découvrez comment faire dans le tutoriel Mettre à jour automatiquement la documentation lorsque du code est fusionné.