mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
d52472c07e
* docs: document OpenAPI overlay support * docs: translate OpenAPI overlay docs to fr, es, zh and trim zh description * docs: describe overlay failure behavior on hosted deployments * docs: tighten overlay section and merge in wording from #7261 Consolidates the two overlay docs PRs into this one. Keeps this PR's structure and anchors (already referenced from the glossary, settings pages, and translations), tightens the prose toward the page's voice, leads with "Use OpenAPI Overlays to...", drops repeated "Mintlify" subjects, and renames the example heading to "Rename a path" to match the page's imperative headings. fr/es/zh mirrors updated to match. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: brandonmcconnell <brandon@mintlify.com> Co-authored-by: Cursor <cursoragent@cursor.com>
382 lines
14 KiB
Plaintext
382 lines
14 KiB
Plaintext
---
|
|
title: "Glosario"
|
|
description: "Definiciones de la terminología de Mintlify sobre producto, contenido, navegación, despliegue, Git, API playground e IA usada en la documentación."
|
|
keywords: ["glosario", "términos", "definiciones", "terminología"]
|
|
---
|
|
|
|
Utiliza este glosario como referencia rápida para los términos usados en Mintlify y a lo largo de esta documentación. Para una visión general de cómo encajan las piezas, consulta [Conceptos](/es/reference/concepts).
|
|
|
|
<div id="a">
|
|
## A
|
|
</div>
|
|
|
|
<div id="admin-mcp-server">
|
|
### Admin MCP server
|
|
</div>
|
|
|
|
Un servidor [Model Context Protocol](#model-context-protocol-mcp) autenticado que permite a herramientas de IA autorizadas leer y actualizar contenido y configuración en uno o varios despliegues de una organización. Los cambios se realizan en una rama y requieren una pull request para fusionarse. Consulta [Admin MCP server](/es/ai/mintlify-mcp).
|
|
|
|
<div id="agent">
|
|
### Agente
|
|
</div>
|
|
|
|
Una herramienta de IA para quienes mantienen la documentación que investiga, escribe, valida y publica los cambios propuestos. El agente puede abrir una pull request o hacer commit en la rama de despliegue, según tu configuración. Consulta [Agente](/es/agent).
|
|
|
|
<div id="anchor">
|
|
### Anchor
|
|
</div>
|
|
|
|
Un enlace de navegación persistente de nivel superior que apunta a un destino interno o externo. Los anchors son uno de los patrones principales de navegación disponibles en `docs.json`. Consulta [Anchors](/es/organize/navigation#anchors).
|
|
|
|
<div id="api-playground">
|
|
### API playground
|
|
</div>
|
|
|
|
Un entorno interactivo en las páginas de endpoints donde los lectores crean, envían e inspeccionan solicitudes de API reales sin salir de tu documentación. Mintlify genera el playground a partir de un documento [OpenAPI](#openapi). Consulta [Información general del API playground](/es/api-playground/overview).
|
|
|
|
<div id="assistant">
|
|
### Assistant
|
|
</div>
|
|
|
|
Una interfaz de IA para lectores de la documentación que responde preguntas a partir de tu contenido. Cita páginas relevantes y puede llevar a los usuarios directamente al contenido pertinente. El assistant no edita tu documentación. Consulta [Assistant](/es/assistant).
|
|
|
|
<div id="automation">
|
|
### Automatización
|
|
</div>
|
|
|
|
Una tarea configurada del agente que se ejecuta según una programación, después de una actualización del repositorio o en respuesta a un evento de una integración conectada. Consulta [Automatizaciones](/es/automations/index).
|
|
|
|
<div id="b">
|
|
## B
|
|
</div>
|
|
|
|
<div id="branch">
|
|
### Rama
|
|
</div>
|
|
|
|
Una línea de trabajo separada en un repositorio Git. Usa ramas para realizar y revisar cambios sin afectar al sitio en producción. Consulta [Conceptos de Git](/es/guides/git-concepts#branch).
|
|
|
|
<div id="build">
|
|
### Build
|
|
</div>
|
|
|
|
El proceso que valida los archivos de tu proyecto y los convierte en un sitio de documentación desplegable. Un build puede producir el sitio en producción o un despliegue de vista previa.
|
|
|
|
<div id="c">
|
|
## C
|
|
</div>
|
|
|
|
<div id="commit">
|
|
### Commit
|
|
</div>
|
|
|
|
Una instantánea guardada de los cambios en un repositorio Git. Publicar desde el editor web crea un commit. Consulta [Conceptos de Git](/es/guides/git-concepts#commit).
|
|
|
|
<div id="component">
|
|
### Componente
|
|
</div>
|
|
|
|
Un elemento MDX reutilizable para presentar contenido estructurado o interactivo, como una tarjeta, un aviso, un acordeón, una pestaña o un grupo de código. Consulta [Componentes](/es/components).
|
|
|
|
<div id="content-directory">
|
|
### Directorio de contenido
|
|
</div>
|
|
|
|
El directorio de un repositorio que contiene `docs.json` y los archivos de un despliegue de Mintlify. Puede ser la raíz del repositorio o un subdirectorio configurado, como `docs/` en un monorepo. Consulta [Configuración de monorepo](/es/deploy/monorepo).
|
|
|
|
<div id="context-repository">
|
|
### Repositorio de contexto
|
|
</div>
|
|
|
|
Un repositorio adicional que el agente puede leer para obtener información de referencia cuando ejecuta una tarea. Un repositorio de contexto no forma parte del sitio de documentación.
|
|
|
|
<div id="credits">
|
|
### Créditos
|
|
</div>
|
|
|
|
Unidades que miden el uso de las funciones de IA de Mintlify. Los créditos se comparten en toda la organización y entre sus despliegues y miembros. Consulta [Créditos](/es/credits).
|
|
|
|
<div id="custom-domain">
|
|
### Dominio personalizado
|
|
</div>
|
|
|
|
Un dominio, subdominio o subruta que conectas a un sitio de Mintlify en lugar de usar su dirección predeterminada `.mintlify.site`. Consulta [Dominio personalizado](/es/customize/custom-domain).
|
|
|
|
<div id="d">
|
|
## D
|
|
</div>
|
|
|
|
<div id="dashboard">
|
|
### Dashboard
|
|
</div>
|
|
|
|
La aplicación autenticada de Mintlify donde tu equipo edita contenido, monitorea despliegues, gestiona miembros y configura los ajustes del proyecto y la organización.
|
|
|
|
<div id="deployment">
|
|
### Despliegue
|
|
</div>
|
|
|
|
Un proyecto de documentación dentro de una organización de Mintlify. Un despliegue conecta el contenido fuente y una rama de despliegue con un sitio en producción. El término también puede referirse a un build específico que se está publicando.
|
|
|
|
<div id="deployment-branch">
|
|
### Rama de despliegue
|
|
</div>
|
|
|
|
La rama de Git usada para construir el sitio en producción, normalmente `main`. Los cambios que se envían o fusionan en esta rama disparan un despliegue de producción. Consulta [Rama de despliegue](/es/guides/git-concepts#deployment-branch).
|
|
|
|
<div id="docs.json">
|
|
### `docs.json`
|
|
</div>
|
|
|
|
El archivo de configuración obligatorio para un sitio de Mintlify. Controla la navegación, la apariencia, las integraciones, la configuración de la API, las redirecciones y otros comportamientos globales. Consulta [`docs.json`](/es/organize/settings).
|
|
|
|
<div id="dropdown">
|
|
### Dropdown
|
|
</div>
|
|
|
|
Una estructura de navegación de nivel superior que agrupa secciones relacionadas en un menú. Consulta [Dropdowns](/es/organize/navigation#dropdowns).
|
|
|
|
<div id="e">
|
|
## E
|
|
</div>
|
|
|
|
<div id="editor">
|
|
### Editor
|
|
</div>
|
|
|
|
El editor basado en el navegador dentro del dashboard de Mintlify. Ofrece edición colaborativa, guardado automático, vistas previas en vivo, sincronización con Git y flujos de publicación. Consulta [Descripción general del editor](/es/editor).
|
|
|
|
<div id="f">
|
|
## F
|
|
</div>
|
|
|
|
<div id="feature-branch">
|
|
### Rama de funcionalidad
|
|
</div>
|
|
|
|
Cualquier rama distinta de la rama de despliegue que uses para preparar cambios. Las ramas de funcionalidad mantienen el trabajo inacabado separado del sitio en producción.
|
|
|
|
<div id="frontmatter">
|
|
### Frontmatter
|
|
</div>
|
|
|
|
Metadatos YAML al inicio de una página MDX, delimitados por líneas `---`. El frontmatter controla propiedades como el título, la descripción, el icono y el diseño de la página. Consulta [Páginas](/es/organize/pages).
|
|
|
|
<div id="g">
|
|
## G
|
|
</div>
|
|
|
|
<div id="group">
|
|
### Grupo
|
|
</div>
|
|
|
|
Una colección etiquetada de páginas o de grupos anidados en la barra lateral. Los grupos organizan contenido relacionado dentro de una sección de navegación. Consulta [Grupos](/es/organize/navigation#groups).
|
|
|
|
<div id="i">
|
|
## I
|
|
</div>
|
|
|
|
<div id="index">
|
|
### Índice
|
|
</div>
|
|
|
|
Un servicio de búsqueda para agentes de programación que recupera contexto técnico actualizado desde documentación mantenida por editores y desde la web a través de un servidor MCP o una API REST. Consulta [Índice](/es/search-index).
|
|
|
|
<div id="integration">
|
|
### Integración
|
|
</div>
|
|
|
|
Una conexión entre Mintlify y otro servicio. Las integraciones pueden proporcionar analíticas, chat, controles de privacidad, ejemplos de SDK, contexto de automatización o disparadores de automatización.
|
|
|
|
<div id="l">
|
|
## L
|
|
</div>
|
|
|
|
<div id="language">
|
|
### Idioma
|
|
</div>
|
|
|
|
Una versión específica por localización de tu documentación configurada en la navegación. Los idiomas crean rutas basadas en la localización y un selector de idioma. Consulta [Idiomas](/es/organize/navigation#languages).
|
|
|
|
<div id="live-preview">
|
|
### Vista previa en vivo
|
|
</div>
|
|
|
|
La renderización que se actualiza continuamente con tus ediciones no publicadas dentro del editor web. Una vista previa en vivo no se despliega públicamente. Consulta [Vista previa en vivo](/es/editor/review#live-preview).
|
|
|
|
<div id="live-site">
|
|
### Sitio en producción
|
|
</div>
|
|
|
|
El sitio de documentación de producción construido a partir de la rama de despliegue y disponible para los lectores en un dominio de Mintlify o un dominio personalizado.
|
|
|
|
<div id="llms.txt">
|
|
### `llms.txt`
|
|
</div>
|
|
|
|
Un archivo de texto generado que ayuda a las herramientas de IA a descubrir las páginas más útiles de un sitio de documentación. `llms-full.txt` incluye el contenido de todas las páginas en un solo archivo. Consulta [`llms.txt`](/es/ai/llmstxt).
|
|
|
|
<div id="m">
|
|
## M
|
|
</div>
|
|
|
|
<div id="markdown">
|
|
### Markdown
|
|
</div>
|
|
|
|
Una sintaxis de texto plano para dar formato al contenido con elementos como encabezados, listas, enlaces y bloques de código. Las páginas publicadas de Mintlify también están disponibles como Markdown añadiendo `.md` a su URL.
|
|
|
|
<div id="mdx">
|
|
### MDX
|
|
</div>
|
|
|
|
Markdown extendido con JSX. Mintlify utiliza archivos de página `.mdx` para que puedas combinar Markdown estándar con componentes y elementos personalizados de React.
|
|
|
|
<div id="merge">
|
|
### Merge
|
|
</div>
|
|
|
|
La operación de Git que combina cambios de una rama en otra. Fusionar una rama de funcionalidad en la rama de despliegue publica sus cambios mediante un nuevo build.
|
|
|
|
<div id="model-context-protocol-mcp">
|
|
### Model Context Protocol (MCP)
|
|
</div>
|
|
|
|
Un protocolo abierto que permite a las aplicaciones de IA conectarse a herramientas y fuentes de datos. Mintlify ofrece un servidor MCP público de solo lectura para cada sitio publicado y un servidor MCP de administración autenticado para gestionar despliegues.
|
|
|
|
<div id="n">
|
|
## N
|
|
</div>
|
|
|
|
<div id="navigation">
|
|
### Navegación
|
|
</div>
|
|
|
|
La jerarquía que utilizan los lectores para desplazarse por un sitio de documentación. Configura la navegación en tu archivo `docs.json` con páginas, grupos, pestañas, dropdowns, productos, versiones, idiomas y anchors. Consulta [Navegación](/es/organize/navigation).
|
|
|
|
<div id="o">
|
|
## O
|
|
</div>
|
|
|
|
<div id="openapi">
|
|
### OpenAPI
|
|
</div>
|
|
|
|
Un formato estándar para describir APIs HTTP. Mintlify puede generar páginas de endpoints, ejemplos de solicitudes y un playground interactivo de API a partir de un documento OpenAPI. Consulta [Configuración de OpenAPI](/es/api-playground/openapi-setup).
|
|
|
|
<div id="organization">
|
|
### Organización
|
|
</div>
|
|
|
|
Un espacio de trabajo de Mintlify que contiene miembros del equipo, configuración a nivel de organización, créditos compartidos y uno o más despliegues.
|
|
|
|
<div id="overlay">
|
|
### Overlay
|
|
</div>
|
|
|
|
Un documento JSON o YAML que describe cambios que se aplican a una especificación de OpenAPI sin editar su archivo de origen. Mintlify aplica los overlays antes de validar y renderizar una especificación. Consulta [Transforma tu especificación con overlays](/es/api-playground/openapi-setup#transform-your-spec-with-overlays).
|
|
|
|
<div id="p">
|
|
## P
|
|
</div>
|
|
|
|
<div id="page">
|
|
### Página
|
|
</div>
|
|
|
|
Un archivo `.mdx` que se renderiza como una ruta en tu sitio de documentación. Una página combina frontmatter, contenido en Markdown y componentes opcionales. Consulta [Páginas](/es/organize/pages).
|
|
|
|
<div id="preview-deployment">
|
|
### Despliegue de vista previa
|
|
</div>
|
|
|
|
Una versión temporal y compartible de un sitio construida a partir de una pull request o una rama seleccionada. Permite a los revisores inspeccionar los cambios antes de que lleguen al sitio en producción. Consulta [Despliegues de vista previa](/es/deploy/preview-deployments).
|
|
|
|
<div id="product">
|
|
### Producto
|
|
</div>
|
|
|
|
Una estructura de navegación de nivel superior para publicar documentación de varios productos distintos en un solo despliegue. Cada producto tiene su propia navegación. Consulta [Productos](/es/organize/navigation#products).
|
|
|
|
<div id="project">
|
|
### Proyecto
|
|
</div>
|
|
|
|
Un término general para un despliegue de Mintlify y su repositorio conectado, configuración y sitio. En la configuración del dashboard y en las APIs, **despliegue** suele ser el término más específico.
|
|
|
|
<div id="publish">
|
|
### Publicar
|
|
</div>
|
|
|
|
Escribir cambios en la documentación en Git para que puedan avanzar hacia el sitio en producción. Según la rama y la configuración de revisión, publicar puede desplegar directamente, guardar un commit en una rama o crear una pull request.
|
|
|
|
<div id="pull-request">
|
|
### Pull request
|
|
</div>
|
|
|
|
Una propuesta para fusionar cambios de una rama de Git en otra. Las pull requests admiten revisión, discusión, comprobaciones automatizadas y despliegues de vista previa antes de que los cambios lleguen a la rama de despliegue. En GitLab se llama **merge request**.
|
|
|
|
<div id="r">
|
|
## R
|
|
</div>
|
|
|
|
<div id="redirect">
|
|
### Redirección
|
|
</div>
|
|
|
|
Una regla que envía a los visitantes desde una URL antigua o alternativa a un nuevo destino. Las redirecciones mantienen los enlaces funcionando cuando el contenido se mueve. Consulta [Redirecciones](/es/create/redirects).
|
|
|
|
<div id="repository">
|
|
### Repositorio
|
|
</div>
|
|
|
|
Una colección de archivos y su historial de Git. El repositorio de documentación es la fuente de verdad para un sitio de Mintlify y contiene sus páginas, configuración y activos.
|
|
|
|
<div id="reusable-snippet">
|
|
### Fragmento reutilizable
|
|
</div>
|
|
|
|
Contenido almacenado en un archivo aparte e importado en una o varias páginas MDX. Actualizar el fragmento fuente actualiza todas las páginas que lo utilizan. Consulta [Fragmentos reutilizables](/es/create/reusable-snippets).
|
|
|
|
<div id="s">
|
|
## S
|
|
</div>
|
|
|
|
<div id="skill.md">
|
|
### `skill.md`
|
|
</div>
|
|
|
|
Un archivo generado que describe las capacidades y la documentación de un producto para agentes de IA. Los usuarios pueden instalarlo como una skill de agente para mejorar los resultados al trabajar con el producto. Consulta [`skill.md`](/es/ai/skillmd).
|
|
|
|
<div id="source-repository">
|
|
### Repositorio fuente
|
|
</div>
|
|
|
|
El repositorio que contiene el código del producto, las definiciones de la API u otro material descrito por la documentación. El agente puede utilizar un repositorio fuente conectado como contexto sin publicar sus archivos en el sitio de documentación.
|
|
|
|
<div id="t">
|
|
## T
|
|
</div>
|
|
|
|
<div id="tab">
|
|
### Pestaña
|
|
</div>
|
|
|
|
Una sección de navegación de nivel superior para áreas paralelas de documentación que sirven a la misma audiencia, como guías y referencia de API. Consulta [Pestañas](/es/organize/navigation#tabs).
|
|
|
|
<div id="theme">
|
|
### Tema
|
|
</div>
|
|
|
|
El diseño base y el sistema visual de un sitio de documentación. Un tema controla la presentación general, mientras que los colores, las fuentes, los logotipos y otros ajustes lo personalizan. Consulta [Temas](/es/customize/themes).
|
|
|
|
<div id="v">
|
|
## V
|
|
</div>
|
|
|
|
<div id="version">
|
|
### Versión
|
|
</div>
|
|
|
|
Una estructura de navegación para publicar varias versiones de la misma documentación en paralelo, como `v1` y `v2`. Consulta [Versiones](/es/organize/navigation#versions).
|