Passer au contenu principal
Créez un fichier .mintlify/AGENTS.md à la racine de votre projet de documentation pour personnaliser le comportement de l’agent (Agents.md est également accepté comme nom de fichier).
Placez votre fichier AGENTS.md dans le répertoire .mintlify/, et non à la racine de votre projet. Si vous stockez le fichier à la racine de votre projet, vos instructions personnalisées seront accessibles publiquement via le chemin /agents.md. Le répertoire .mintlify/ n’est pas servi publiquement, donc votre fichier AGENTS.md ne sera pas accessible lorsqu’il se trouve dans ce répertoire.Si vous devez stocker votre fichier AGENTS.md à la racine de votre projet ou dans un autre répertoire, ajoutez-le à votre fichier .mintignore pour l’exclure de votre site de documentation.
Ajoutez toutes les instructions que vous voulez que l’agent suive. L’agent ajoute ces instructions à son prompt système, de sorte qu’elles s’appliquent à toutes les tâches, que vous utilisiez l’agent dans votre Dashboard, sur Slack ou via l’API.

Ce qu’il faut inclure dans AGENTS.md

Envisagez d’ajouter des consignes concernant :
  • Préférences de style : Voix, ton, mise en forme et terminologie propres à votre documentation.
  • Normes de code : Langages de programmation, frameworks et conventions de codage à utiliser dans les exemples.
  • Exigences de contenu : Quelles sections ou quelles informations inclure pour différents types de pages.
  • Contexte du projet : Détails spécifiques sur votre produit, votre architecture ou votre base d’utilisateurs qui influencent les décisions de documentation.

Exemple de fichier AGENTS.md

.mintlify/AGENTS.md