Saltar al contenido principal
El archivo install.md proporciona instrucciones de instalación centradas en tareas para agentes de IA como Claude Code, Cursor y ChatGPT. A diferencia de la documentación tradicional escrita para lectores humanos, install.md presenta los pasos de instalación como comandos directos que los agentes de IA ejecutan de forma autónoma. Mintlify genera automáticamente un archivo install.md en la raíz de tu proyecto agregando y sintetizando las páginas de documentación relacionadas con la instalación. Este archivo siempre se mantiene actualizado y no requiere mantenimiento. Consulta tu install.md añadiendo /install.md a la URL de tu sitio de documentación. Abrir el install.md de este sitio.

​
Cómo funciona install.md

Mintlify identifica automáticamente las páginas de tu documentación que contienen contenido relacionado con la instalación, comparando palabras clave en las rutas y en los títulos de las páginas. Las páginas ocultas y las páginas excluidas de la indexación se filtran automáticamente.
  • installation o install
  • quickstart o quick-start
  • getting-started o getting_started
  • setup o set-up
  • introduction o intro
  • overview
Mintlify sintetiza estas páginas en un formato conciso y orientado a tareas, optimizado para la ejecución por agentes de IA.
  1. Extrae todos los comandos de shell, las URL y las instrucciones específicas de la plataforma.
  2. Reorganiza el contenido en un objetivo claro con criterios de éxito.
  3. Presenta los pasos como comandos directos en lugar de documentación pasiva.
  4. Incluye una lista de verificación TODO para que los agentes hagan seguimiento del progreso.
  5. Elimina las secciones de resolución de problemas y las funcionalidades opcionales para centrarse en la ruta de instalación principal.
Mintlify no genera un archivo install.md cuando:
  • Tu documentación es privada o requiere Autenticación.
  • Tienes un archivo install.md personalizado en la raíz de tu proyecto.
  • No se encuentran páginas relacionadas con la instalación en tu documentación.

​
Estructura de install.md

Un archivo install.md es un archivo Markdown sin formato que contiene:
  • Apertura conversacional: Plantea el contenido como una solicitud del usuario para activar la ejecución autónoma.
  • Declaración de objetivo: Meta clara de lo que se debe instalar.
  • Condición de éxito: Resultado específico y medible que demuestre una instalación correcta.
  • Lista de verificación TODO: Tareas de alto nivel.
  • Instrucciones detalladas: Comandos paso a paso con todos los comandos de shell necesarios.
  • Directiva de ejecución: Declaración de cierre que activa la acción inmediata.

​
Archivo install.md personalizado

Para agregar un archivo install.md personalizado, crea un archivo install.md en la raíz de tu proyecto. Al agregar un archivo personalizado se reemplaza el archivo generado automáticamente. Si eliminas el archivo personalizado, Mintlify generará un nuevo archivo install.md. Tu archivo install.md personalizado debe seguir un formato orientado a tareas, con una introducción conversacional, un objetivo claro, criterios de éxito y una lista de tareas TODO para maximizar la efectividad con agentes de IA.