mintlify__docs/fr/guides/codex.mdx

---
title: "Rédiger de la documentation avec Codex"
sidebarTitle: "Codex"
description: "Configurez OpenAI Codex CLI avec des instructions de projet et MCP pour rédiger une documentation Mintlify conforme à votre guide de style et au MDX."
keywords: ["Codex", "OpenAI Codex", "AGENTS.md", "documentation IA", "Codex CLI"]
---

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.

<div id="getting-started">
  ## Démarrer
</div>

**Prérequis :**
- Un compte OpenAI avec accès à Codex

**Configuration :**
1. Installez Codex CLI :
  ```bash
  npm install -g @openai/codex
  ```
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](https://developers.openai.com/codex/cli) pour découvrir des alternatives d'installation et des options d'authentification.

<div id="use-codex-with-mintlify">
  ## Utilisez Codex avec Mintlify
</div>

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](https://developers.openai.com/codex/guides/agents-md) dans la documentation Codex pour des détails complets.

<div id="example-agentsmd">
  ## Exemple d'AGENTS.md
</div>

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.

```markdown AGENTS.md
# Mintlify documentation project

## Project context

- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter
- Navigation is configured in `docs.json`
- We follow technical writing best practices

## Writing standards

- Use second person ("you") for instructions
- Write in active voice and present tense
- Use sentence case for headings ("Getting started", not "Getting Started")
- Start procedures with prerequisites
- Include expected outcomes for major steps
- Keep sentences concise but informative
- Never use marketing language ("powerful", "seamless", "robust")

## Required page structure

Every page must start with frontmatter:

---
title: "Clear, specific title"
description: "Concise description for SEO and navigation."
keywords: ["relevant", "keywords", "here"]
---

## Mintlify components

### docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when modifying navigation or site settings

### Callouts

- `<Note>` for helpful supplementary information
- `<Warning>` for important cautions and breaking changes
- `<Tip>` for best practices and expert advice
- `<Info>` for neutral contextual information
- `<Check>` for success confirmations

### Code examples

- All code blocks must have a language tag
- Use `<CodeGroup>` for multiple language examples
- Use `<RequestExample>` and `<ResponseExample>` for API docs

### Procedures

- Use `<Steps>` for sequential instructions
- Include verification steps with `<Check>` when relevant

### Content organization

- Use `<Tabs>` for platform-specific content
- Use `<Accordion>` for progressive disclosure
- Use `<Card>` and `<CardGroup>` for highlighting content
- Wrap images in `<Frame>` with descriptive alt text

## Internal links

Use root-relative paths: `/guides/quickstart`, not `../quickstart` or full URLs.

## Quality checklist

Before finishing any documentation task:
- Verify all code blocks have language tags
- Check that frontmatter includes title, description, and keywords
- Confirm internal links use root-relative paths
- Read changes aloud to catch awkward phrasing
```

<div id="working-with-codex">
  ## Utilisation de Codex
</div>

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.

<div id="example-prompts">
  ### Exemples d'instructions
</div>

**Rédaction de nouveau contenu** :

```text wrap
Créez une nouvelle page à l'emplacement guides/authentication.mdx expliquant comment s'authentifier avec notre API. Incluez des exemples de code en JavaScript et Python.
```

**Amélioration du contenu existant** :

```text wrap
Examinez docs/quickstart.mdx et proposez des améliorations pour la clarté. Concentrez-vous sur la facilitation du suivi des étapes et assurez-vous que les composants sont utilisés correctement.
```

**Mise à jour de la navigation** :

```text wrap
J'ai ajouté une nouvelle page à guides/webhooks.mdx. Ajoutez-la à la section Guides dans docs.json après guides/authentication.
```

**Assurer la cohérence** :

```text wrap
Vérifiez si cette nouvelle page respecte les normes de rédaction d'AGENTS.md et signalez tout problème.
```

<div id="enhance-with-mcp-server">
  ## Améliorez avec le serveur MCP
</div>

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`. Créez le fichier s'il n'existe pas :

```toml
[mcp_servers.mintlify]
url = "https://mintlify.com/docs/mcp"
```

Pour vous connecter au serveur MCP de votre propre site de documentation, remplacez l'URL par le point de terminaison MCP de votre site :

```toml
[mcp_servers.my-docs]
url = "https://your-docs.mintlify.site/mcp"
```

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](/fr/ai/model-context-protocol) pour plus d'informations sur les serveurs MCP et savoir comment trouver le point de terminaison MCP de votre site.