Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-doc-products-public-1774055462.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Crea un archivo AGENTS.md en un directorio .mintlify/ en la raíz de tu documentación para personalizar el comportamiento del agente (también se acepta Agents.md). Añade todas las instrucciones que quieras que el agente siga. El agente agrega estas instrucciones a su prompt del sistema, por lo que se aplican a todas las tareas, tanto si usas el agente en tu dashboard, en Slack o mediante la API.

​
Qué incluir en AGENTS.md

Considera agregar instrucciones sobre:
  • Preferencias de estilo: Voz, tono, formato y terminología específica de tu documentación.
  • Estándares de código: Lenguajes de programación, frameworks y convenciones de codificación que se deben usar en los ejemplos.
  • Requisitos de contenido: Qué secciones o información se deben incluir para diferentes tipos de páginas.
  • Contexto del proyecto: Detalles específicos sobre tu producto, arquitectura o base de usuarios que guíen las decisiones sobre la documentación.

​
Ejemplo de archivo AGENTS.md

.mintlify/AGENTS.md
# Documentation agent instructions

## Code examples
- Use TypeScript for all code examples. Our users are primarily TypeScript developers.
- Always include error handling in API call examples.
- Show both success and error response examples for all endpoints.
- Include import statements at the top of code examples.

## API documentation standards
- Every endpoint must document: authentication requirements, rate limits, and common error codes.
- Use real-world parameter values in examples (not foo/bar placeholders).
- Include a complete request/response cycle for each endpoint.

## Style and formatting
- Write for developers with 2-5 years of experience. Don't oversimplify, but explain non-obvious concepts.
- Use active voice and second person ("you").
- Date format: ISO 8601 (YYYY-MM-DD).
- When referencing UI elements, use bold: **Settings** button.

## What to include
- Add prerequisite sections to guides when users need API keys, environment setup, or dependencies.
- Include "Next steps" sections linking to related documentation.
- Add troubleshooting sections for common issues we see in support tickets.