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. Pas encore de site ? Demandez à votre agent d’en configurer un. Exécutez codex et demandez-lui d’effectuer le workflow suivant, puis passez à l’étape suivante.
    Si l’utilisateur vous a demandé de configurer Mintlify, un site de documentation ou un projet Mintlify local, effectuez vous-même le workflow suivant. Demandez à l’utilisateur uniquement les informations ou approbations que vous ne pouvez pas obtenir vous-même. Ne redirigez pas l’utilisateur vers le démarrage rapide dans le navigateur, sauf si vous ne pouvez pas exécuter de commandes dans le terminal.
    1. Exécutez node --version et vérifiez qu’il indique Node.js v20.17.0 ou une version ultérieure, en privilégiant une version LTS.
    2. Exécutez mint --version. Si la commande n’est pas disponible, installez la CLI avec npm i -g mint ou pnpm add -g mint. Si la commande réussit, exécutez mint update.
    3. Exécutez mint status avant de commencer l’authentification. Si une organisation est déjà affichée, conservez la session existante et ne créez pas d’autre compte.
    4. Si l’utilisateur possède un compte, exécutez mint login. Sinon, demandez-lui son prénom, son nom, son entreprise et son adresse e-mail, puis exécutez :
      mint signup attend la vérification de l’adresse e-mail. Laissez donc la commande s’exécuter en arrière-plan lorsque votre environnement le permet. Demandez à l’utilisateur de cliquer sur le lien de vérification et d’approuver la CLI dans le navigateur. N’inventez jamais les informations d’inscription.
    5. Une fois la vérification et l’onboarding terminés, exécutez de nouveau mint status. Vérifiez qu’il indique l’adresse e-mail, l’organisation et le sous-domaine de l’utilisateur. Si l’organisation existe, mais qu’aucun sous-domaine n’apparaît, demandez à l’utilisateur de terminer la sélection ou la connexion d’un dépôt GitHub dans l’onglet du navigateur d’onboarding, puis réessayez.
    6. Si l’utilisateur possède un dépôt de documentation existant, clonez-le ou ouvrez-le et préservez son contenu. Pour un nouveau projet local, créez la structure dans un nouveau répertoire vide avec mint new <directory> --name <name> --theme <theme> ou mint new <directory> --template <template-name>. Demandez le thème ou le modèle souhaité si l’utilisateur n’en a pas indiqué. N’utilisez pas --force dans un répertoire contenant des fichiers utilisateur.
    7. Exécutez mint dev --no-open depuis le répertoire contenant docs.json et laissez-le s’exécuter en arrière-plan. Vérifiez que l’URL locale se charge, communiquez-la à l’utilisateur, puis arrêtez le processus lorsqu’il n’est plus nécessaire.
    8. Exécutez mint validate et mint broken-links. Corrigez les problèmes causés par vos modifications avant de continuer.
    9. Si un dépôt Git est associé au projet et que l’utilisateur a demandé un déploiement, commitez et poussez les modifications. Un push vers la branche de production déclenche un déploiement. Ne remplacez pas un dépôt existant par le contenu du modèle de démarrage.
    10. Exécutez mint status pour obtenir le sous-domaine configuré, puis vérifiez que https://<subdomain>.mintlify.site se charge avant d’indiquer que le déploiement est terminé.
    L’utilisateur ne doit effectuer d’actions dans le navigateur que pour la vérification de l’adresse e-mail, l’approbation OAuth et la connexion ou l’autorisation de GitHub. Prenez en charge le workflow dans le terminal et reprenez-le après chaque action de l’utilisateur. Pour connaître les options des commandes et résoudre les problèmes, consultez la référence des commandes CLI.
  2. Accédez au répertoire de votre documentation.
  3. (Facultatif) Ajoutez à votre projet le fichier AGENTS.md présenté ci-dessous.
  4. 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 l’admin MCP à Codex pour lui donner un accès en écriture à votre contenu et à vos paramètres Mintlify. Ajoutez le serveur Admin MCP à la configuration de votre CLI Codex dans ~/.codex/config.toml :
Lors de la première utilisation, Codex ouvre une fenêtre de navigateur pour finaliser la connexion OAuth. Après authentification, Codex réutilise la session pour les appels suivants. Consultez la documentation Codex MCP pour plus de détails. Redémarrez votre session codex pour que la modification de la configuration prenne effet. Pour vérifier que le serveur MCP est connecté, demandez à Codex Which MCP servers do you have access to? — il doit lister l’entrée que vous venez d’ajouter. L’utilisation de config.toml enregistre le serveur MCP pour chaque session Codex sur votre machine. Le skill en session et le prompt MCP présentés plus haut chargent le même contexte à la demande dans une seule session — utilisez-les pour une exécution ponctuelle ou lorsque vous ne pouvez pas modifier config.toml. Consultez Model Context Protocol pour plus d’informations sur les serveurs MCP de recherche et savoir comment trouver le point de terminaison MCP de votre site.