Saltar al contenido principal
Usa la CLI de Codex de OpenAI para escribir y mantener documentación de Mintlify desde la terminal. Las instrucciones de proyecto en AGENTS.md proporcionan a Codex un contexto persistente sobre tus estándares de documentación, componentes y guía de estilo.

Empezar

Requisitos previos:
  • Una cuenta de OpenAI con acceso a Codex
Configuración:
  1. Instala la CLI de Codex:
  1. Ve al directorio de tu documentación.
  2. (Opcional) Añade a tu proyecto el archivo AGENTS.md que aparece más abajo.
  3. Ejecuta codex para iniciar una sesión.
Consulta la documentación de la CLI de Codex para conocer alternativas de instalación y opciones de autenticación.

Usa Codex con Mintlify

Codex lee archivos AGENTS.md de tu repositorio para comprender las reglas y convenciones específicas del proyecto antes de empezar a trabajar. Puedes colocar un AGENTS.md en la raíz de tu repositorio de documentación para darle a Codex contexto sobre los componentes de Mintlify, tus estándares de redacción y cómo estructuras tu documentación. Codex detecta archivos AGENTS.md en varios niveles:
  • Instrucciones globales en ~/.codex/AGENTS.md se aplican a todos tus proyectos.
  • Instrucciones del proyecto en la raíz de tu repositorio (o en cualquier subdirectorio) se aplican al trabajo realizado en ese ámbito.
Codex concatena estos archivos desde la raíz hasta el directorio actual, de modo que las instrucciones a nivel de proyecto amplían o anulan las globales. Crea un AGENTS.md en la raíz de tu repositorio de documentación y haz commit para que todas las personas colaboradoras se beneficien del mismo contexto. Consulta AGENTS.md en la documentación de Codex para conocer todos los detalles.

Ejemplo de AGENTS.md

Este archivo proporciona a Codex contexto sobre los componentes de Mintlify y los estándares de redacción técnica. Personalízalo para tu documentación:
  • Estándares de redacción: Actualiza las pautas de lenguaje para alinearlas con tu guía de estilo.
  • Patrones de componentes: Agrega componentes específicos del proyecto o modifica los ejemplos existentes.
  • Ejemplos de código: Reemplaza los ejemplos genéricos con llamadas y respuestas reales de la API para tu producto.
  • Preferencias de estilo y tono: Ajusta la terminología, el formato y otras reglas.
Guárdalo como AGENTS.md en la raíz de tu repositorio de documentación.
AGENTS.md

Trabajar con Codex

Una vez que tengas tu AGENTS.md en su lugar, Codex lo detecta automáticamente cuando inicias una sesión en tu repositorio de documentación.

Ejemplos de indicaciones

Redacción de contenido nuevo:
Mejorar el contenido existente:
Actualizar la navegación:
Mantener la consistencia:

Mejora con el servidor MCP

Conecta el servidor MCP de Mintlify a Codex para darle acceso a buscar en la documentación de Mintlify mientras te ayuda a escribir. Cuando conectas el servidor MCP, Codex puede consultar el uso de los componentes y las opciones de configuración sin que tengas que salir de la terminal. Agrega el servidor MCP a tu configuración global de Codex en ~/.codex/config.toml:
Para conectarte en su lugar al servidor MCP de tu propio sitio de documentación, reemplaza la URL por el endpoint MCP de tu sitio:
Consulta Model Context Protocol para obtener más información sobre los servidores MCP y cómo encontrar el endpoint MCP de tu sitio.