Passer au contenu principal
Utilisez Codex CLI d’OpenAI pour rédiger et maintenir votre documentation Mintlify depuis le terminal. Les instructions de projet dans AGENTS.md fournissent à Codex un contexte persistant sur vos standards de documentation, vos composants et votre guide de style.

Démarrer

Prérequis :
  • Un compte OpenAI avec accès à Codex
Configuration :
  1. Installez Codex CLI :
  1. Accédez au répertoire de votre documentation.
  2. (Facultatif) Ajoutez à votre projet le fichier AGENTS.md présenté ci-dessous.
  3. Exécutez codex pour démarrer une session.
Consultez la documentation de Codex CLI pour découvrir des alternatives d’installation et des options d’authentification.

Utilisez Codex avec Mintlify

Codex lit les fichiers AGENTS.md de votre référentiel pour comprendre les règles et conventions propres au projet avant de commencer à travailler. Vous pouvez placer un fichier AGENTS.md à la racine de votre dépôt de documentation pour fournir à Codex du contexte sur les composants Mintlify, vos normes de rédaction et la façon dont vous structurez votre documentation. Codex découvre les fichiers AGENTS.md à plusieurs niveaux :
  • Les instructions globales dans ~/.codex/AGENTS.md s’appliquent à tous vos projets.
  • Les instructions de projet à la racine de votre dépôt (ou dans n’importe quel sous-répertoire) s’appliquent au travail effectué dans cette portée.
Codex concatène ces fichiers depuis la racine jusqu’au répertoire courant, de sorte que les instructions au niveau du projet étendent ou remplacent celles globales. Créez un fichier AGENTS.md à la racine de votre dépôt de documentation et committez-le pour que tous les contributeurs bénéficient du même contexte. Consultez AGENTS.md dans la documentation Codex pour des détails complets.

Exemple d’AGENTS.md

Ce fichier fournit à Codex du contexte sur les composants Mintlify et les standards de rédaction technique. Personnalisez-le pour votre documentation :
  • Normes de rédaction : mettez à jour les consignes linguistiques pour les aligner sur votre guide de style.
  • Modèles de composants : ajoutez des composants spécifiques à votre projet ou modifiez des exemples existants.
  • Exemples de code : remplacez les exemples génériques par de vrais appels et réponses d’API propres à votre produit.
  • Préférences de style et de ton : ajustez la terminologie, la mise en forme et les autres règles.
Enregistrez ce fichier sous le nom AGENTS.md à la racine de votre dépôt de documentation.
AGENTS.md

Utilisation de Codex

Une fois votre fichier AGENTS.md en place, Codex le détecte automatiquement lorsque vous démarrez une session dans votre dépôt de documentation.

Exemples d’instructions

Rédaction de nouveau contenu :
Amélioration du contenu existant :
Mise à jour de la navigation :
Assurer la cohérence :

Améliorez avec le serveur MCP

Connectez le serveur MCP de Mintlify à Codex pour lui permettre de rechercher dans la documentation Mintlify tout en vous aidant à rédiger. Lorsque vous connectez le serveur MCP, Codex peut consulter l’utilisation des composants et les options de configuration sans que vous ayez à quitter le terminal. Ajoutez le serveur MCP à votre configuration globale Codex dans ~/.codex/config.toml :
Pour vous connecter au serveur MCP de votre propre site de documentation, remplacez l’URL par le point de terminaison MCP de votre site :
Consultez Model Context Protocol pour plus d’informations sur les serveurs MCP et savoir comment trouver le point de terminaison MCP de votre site.