diff --git a/es.json b/es.json index e5ee4a0327..1a85494d95 100644 --- a/es.json +++ b/es.json @@ -5,11 +5,11 @@ "groups": [ { "group": "Primeros pasos", - "icon": "rocket", "boost": 2, "pages": [ "es/index", "es/quickstart", + "es/ai-native", { "group": "CLI", "root": "es/cli/index", @@ -19,94 +19,32 @@ "es/cli/commands" ] }, - "es/ai-native" - ] - }, - { - "group": "Organizar", - "icon": "map", - "pages": [ - { - "group": "Configuración global", - "root": "es/organize/settings", - "pages": [ - "es/organize/settings-appearance", - "es/organize/settings-structure", - "es/organize/settings-api", - "es/organize/settings-integrations", - "es/organize/settings-seo", - "es/organize/settings-reference" - ] - }, - "es/organize/navigation", - "es/organize/pages", - "es/organize/hidden-pages", - "es/organize/related-pages", - "es/organize/mintignore" - ] - }, - { - "group": "Personalizar", - "icon": "paint-bucket", - "pages": [ - "es/customize/custom-domain", - "es/customize/themes", - "es/customize/fonts", - "es/customize/custom-scripts", - "es/customize/react-components", - "es/customize/custom-404-page" + "es/migration" ] }, { "group": "Crear contenido", - "icon": "pen-line", "pages": [ { - "group": "Editor web", + "group": "Páginas", "pages": [ - "es/editor/index", - "es/editor/tutorial", - "es/editor/git-essentials", - "es/editor/pages", - "es/editor/media", - "es/editor/navigation", - "es/editor/live-preview", - "es/editor/branching-and-publishing", - "es/editor/publish", - "es/editor/comments", - "es/editor/suggestions", - "es/editor/agent", - "es/editor/configurations", - "es/editor/settings", - "es/editor/keyboard-shortcuts" - ] - }, - "es/create/text", - "es/create/code", - { - "group": "Asistente", - "pages": [ - "es/agent/index", - "es/agent/slack", - "es/agent/customize", - "es/agent/effective-prompts", - "es/agent/workflows" + "es/organize/pages", + "es/organize/hidden-pages", + "es/organize/related-pages" ] }, { - "group": "Automatizaciones", + "group": "Formato", "pages": [ - "es/automations/index", - "es/automations/reference", - "es/automations/manage", - "es/automations/integrations", - "es/automations/create" + "es/create/text", + "es/create/code", + "es/create/list-table" ] }, { "group": "Componentes", + "root": "es/components/index", "pages": [ - "es/components/index", "es/components/accordions", "es/components/badge", "es/components/banner", @@ -131,164 +69,280 @@ "es/components/tree", "es/components/update", "es/components/view", - "es/components/visibility" + "es/components/visibility", + "es/customize/react-components" + ] + }, + { + "group": "Medios", + "pages": [ + "es/create/image-embeds", + "es/create/files" ] }, - "es/create/image-embeds", - "es/create/files", - "es/create/list-table", "es/create/reusable-snippets", "es/create/personalization", - "es/create/redirects", - "es/create/changelogs" - ] - }, - { - "group": "Documentar APIs", - "icon": "file-braces", - "pages": [ - "es/api-playground/overview", - "es/api-playground/openapi-setup", - "es/api-playground/complex-data-types", - "es/api-playground/adding-sdk-examples", - "es/api-playground/managing-page-visibility", - "es/api-playground/multiple-responses", - "es/api-playground/mdx-setup", - "es/api-playground/asyncapi-setup", - "es/api-playground/graphql-setup", - "es/api-playground/sdk-reference-setup", - "es/api-playground/troubleshooting" + { + "group": "Editor web", + "root": "es/editor/index", + "pages": [ + "es/editor/tutorial", + "es/editor/git-essentials", + "es/editor/pages", + "es/editor/navigation", + "es/editor/live-preview", + "es/editor/branching-and-publishing", + "es/editor/comments", + "es/editor/suggestions", + "es/editor/agent", + "es/editor/configurations", + "es/editor/settings", + "es/editor/keyboard-shortcuts" + ] + }, + "es/deploy/ci" ] }, { - "group": "Desplegar", - "icon": "boxes", + "group": "Administra tu sitio", "pages": [ - "es/deploy/deployments", - "es/deploy/preview-deployments", - "es/deploy/export", { - "group": "Alojamiento en subruta", + "group": "Configuración global", + "root": "es/organize/settings", + "pages": [ + "es/organize/settings-appearance", + "es/organize/settings-structure", + "es/organize/settings-api", + "es/organize/settings-integrations", + "es/organize/settings-seo", + "es/organize/settings-reference" + ] + }, + "es/organize/navigation", + "es/ai/contextual-menu", + "es/create/redirects", + "es/organize/mintignore", + { + "group": "Configuración del repositorio", + "pages": [ + "es/deploy/monorepo", + "es/deploy/multi-repo" + ] + }, + { + "group": "Personalización visual", + "pages": [ + "es/customize/themes", + "es/customize/fonts", + "es/customize/custom-scripts", + "es/customize/custom-404-page" + ] + }, + "es/optimize/analytics", + "es/optimize/feedback", + { + "group": "Despliegues", + "root": "es/deploy/deployments", "pages": [ - "es/deploy/docs-subpath", - "es/deploy/cloudflare", - "es/deploy/route53-cloudfront", - "es/deploy/vercel", - "es/deploy/reverse-proxy", - "es/deploy/csp-configuration" + "es/deploy/preview-deployments", + "es/deploy/github", + "es/deploy/ghes", + "es/deploy/gitlab" ] }, - "es/deploy/authentication-setup", { - "group": "Acceso al Dashboard", + "group": "Hospedaje", + "root": "es/customize/custom-domain", + "pages": [ + { + "group": "Alojamiento en subruta", + "root": "es/deploy/docs-subpath", + "pages": [ + "es/deploy/cloudflare", + "es/deploy/route53-cloudfront", + "es/deploy/vercel", + "es/deploy/vercel-external-proxies", + "es/deploy/reverse-proxy" + ] + }, + "es/deploy/csp-configuration", + "es/deploy/self-host", + "es/deploy/custom-portal" + ] + }, + { + "group": "Exporta tu sitio", + "pages": [ + "es/deploy/export", + "es/optimize/pdf-exports" + ] + }, + { + "group": "Autenticación", + "root": "es/deploy/authentication-setup", "pages": [ "es/dashboard/sso", - "es/dashboard/session-security", - "es/dashboard/network-access", "es/dashboard/scim", - "es/dashboard/permissions", + "es/dashboard/session-security" + ] + }, + { + "group": "Seguridad", + "pages": [ + "es/dashboard/network-access", "es/dashboard/roles", + "es/dashboard/permissions", "es/dashboard/audit-logs", "es/dashboard/security-contact" ] - }, - "es/deploy/monorepo", - "es/deploy/multi-repo", - "es/deploy/vercel-external-proxies", - "es/deploy/ci", - "es/deploy/github", - "es/deploy/ghes", - "es/deploy/gitlab", - "es/deploy/gitlab-self-hosted", - "es/deploy/self-host", - "es/deploy/custom-portal" + } ] }, { - "group": "Optimizar", - "icon": "wrench", + "group": "Agente", "pages": [ + "es/agent/index", + "es/agent/slack", { - "group": "Assistant", - "root": "es/assistant/index", + "group": "Automatizaciones", + "root": "es/automations/index", "pages": [ - "es/assistant/configure", - "es/assistant/customize", - "es/assistant/widget", - "es/assistant/skills", - "es/assistant/use" + "es/automations/create", + "es/automations/manage", + "es/automations/integrations", + "es/automations/reference", + "es/deploy/gitlab-self-hosted" ] }, - "es/credits", - "es/ai/contextual-menu", - "es/optimize/analytics", - "es/optimize/feedback", - "es/ai/llmstxt", - "es/ai/skillmd", - "es/ai/model-context-protocol", + "es/agent/customize", + "es/agent/effective-prompts", + "es/agent/use-cases" + ] + }, + { + "group": "Assistant", + "pages": [ + "es/assistant/index", + "es/assistant/configure", + "es/assistant/customize", + "es/assistant/widget", + "es/assistant/skills", + "es/assistant/use" + ] + }, + { + "group": "Contenido preparado para agentes", + "pages": [ "es/ai/mintlify-mcp", - "es/optimize/search", { "group": "Mintlify Index", + "root": "es/search-index/index", "pages": [ - "es/search-index/index", "es/search-index/connect", "es/search-index/mcp" ] }, - "es/optimize/seo", - "es/ai/markdown-export", - "es/optimize/pdf-exports", + "es/ai/model-context-protocol", + "es/ai/llmstxt", + "es/ai/skillmd", + "es/ai/markdown-export" + ] + }, + { + "group": "Búsqueda y SEO", + "pages": [ + "es/optimize/search", + "es/optimize/seo" + ] + }, + { + "group": "Documentar APIs", + "pages": [ + "es/api-playground/overview", { - "group": "Integraciones", + "group": "Especificaciones de API", "pages": [ + "es/api-playground/openapi-setup", + "es/api-playground/asyncapi-setup", + "es/api-playground/graphql-setup", { - "group": "Analytics", - "pages": [ - "es/integrations/analytics/overview", - "es/integrations/analytics/amplitude", - "es/integrations/analytics/clarity", - "es/integrations/analytics/clearbit", - "es/integrations/analytics/fathom", - "es/integrations/analytics/google-analytics", - "es/integrations/analytics/google-tag-manager", - "es/integrations/analytics/heap", - "es/integrations/analytics/hightouch", - "es/integrations/analytics/hotjar", - "es/integrations/analytics/logrocket", - "es/integrations/analytics/mixpanel", - "es/integrations/analytics/pirsch", - "es/integrations/analytics/plausible", - "es/integrations/analytics/posthog", - "es/integrations/analytics/segment" - ] - }, - { - "group": "SDKs", - "pages": [ - "es/integrations/sdks/speakeasy", - "es/integrations/sdks/stainless" - ] - }, - { - "group": "Soporte", - "pages": [ - "es/integrations/support/overview", - "es/integrations/support/intercom", - "es/integrations/support/front" - ] - }, - { - "group": "Privacidad", + "group": "Configuración de referencia de SDK", + "root": "es/api-playground/sdk-reference-setup", "pages": [ - "es/integrations/privacy/overview", - "es/integrations/privacy/osano", - "es/integrations/privacy/transcend" + "es/api-playground/adding-sdk-examples" ] } ] + }, + { + "group": "Páginas de endpoint", + "pages": [ + "es/api-playground/complex-data-types", + "es/api-playground/multiple-responses", + "es/api-playground/managing-page-visibility", + "es/api-playground/mdx-setup" + ] + }, + "es/api-playground/troubleshooting" + ] + }, + { + "group": "Integraciones", + "pages": [ + { + "group": "Analytics", + "root": "es/integrations/analytics/overview", + "pages": [ + "es/integrations/analytics/adobe", + "es/integrations/analytics/amplitude", + "es/integrations/analytics/clarity", + "es/integrations/analytics/clearbit", + "es/integrations/analytics/fathom", + "es/integrations/analytics/google-analytics", + "es/integrations/analytics/google-tag-manager", + "es/integrations/analytics/heap", + "es/integrations/analytics/hightouch", + "es/integrations/analytics/hotjar", + "es/integrations/analytics/logrocket", + "es/integrations/analytics/mixpanel", + "es/integrations/analytics/pirsch", + "es/integrations/analytics/plausible", + "es/integrations/analytics/posthog", + "es/integrations/analytics/segment" + ] + }, + { + "group": "SDKs", + "pages": [ + "es/integrations/sdks/speakeasy", + "es/integrations/sdks/stainless" + ] + }, + { + "group": "Soporte", + "root": "es/integrations/support/overview", + "pages": [ + "es/integrations/support/intercom", + "es/integrations/support/front" + ] + }, + { + "group": "Privacidad", + "root": "es/integrations/privacy/overview", + "pages": [ + "es/integrations/privacy/osano", + "es/integrations/privacy/transcend" + ] } ] + }, + { + "group": "Referencia", + "pages": [ + "es/reference/concepts", + "es/reference/glossary", + "es/credits" + ] } ] }, @@ -297,14 +351,12 @@ "groups": [ { "group": "Referencia de la API", - "icon": "file-braces", "pages": [ "es/api/introduction" ] }, { "group": "Administración", - "icon": "activity", "pages": [ "es/api/update/trigger", "es/api/update/status", @@ -315,7 +367,6 @@ }, { "group": "Agente", - "icon": "pen-line", "pages": [ "es/api/agent/v2/create-agent-job", "es/api/agent/v2/get-agent-job", @@ -323,15 +374,13 @@ ] }, { - "group": "assistant", - "icon": "bot-message-square", + "group": "Assistant", "pages": [ "es/api/assistant/create-assistant-message-v2" ] }, { "group": "Búsqueda", - "icon": "search", "pages": [ "es/api/assistant/search", "es/api/assistant/get-page-content" @@ -339,7 +388,6 @@ }, { "group": "Mintlify Index", - "icon": "library", "pages": [ "es/api/search-index/introduction", "es/api/search-index/context", @@ -349,16 +397,18 @@ }, { "group": "Analytics", - "icon": "chart-line", "pages": [ "es/api/analytics/feedback", + "es/api/analytics/feedback-by-page", "es/api/analytics/assistant-conversations", - "es/api/analytics/assistant-caller-stats" + "es/api/analytics/assistant-caller-stats", + "es/api/analytics/searches", + "es/api/analytics/views", + "es/api/analytics/visitors" ] }, { "group": "Exportación estática", - "icon": "package", "pages": [ "es/api/static-export/start-job", "es/api/static-export/get-job-status", @@ -368,11 +418,10 @@ ] }, { - "tab": "cambios", + "tab": "Cambios", "groups": [ { - "group": "cambios", - "icon": "calendar", + "group": "Cambios", "boost": 0.5, "pages": [ "es/changelog" @@ -426,6 +475,7 @@ "icon": "trophy", "pages": [ "es/guides/accessibility", + "es/create/changelogs", "es/guides/content-types", "es/guides/content-templates", "es/guides/custom-layouts", @@ -434,7 +484,6 @@ "es/guides/linking", "es/guides/maintenance", "es/guides/media", - "es/migration", "es/guides/navigation", "es/guides/seo", "es/guides/style-and-tone", diff --git a/es/guides/knowledge-base.mdx b/es/guides/knowledge-base.mdx index cef4528392..494ac1420a 100644 --- a/es/guides/knowledge-base.mdx +++ b/es/guides/knowledge-base.mdx @@ -10,7 +10,7 @@ Una base de conocimientos interna ayuda a tu equipo a encontrar respuestas y man Mintlify proporciona la infraestructura para bases de conocimientos a las que todo tu equipo puede contribuir. * **Búsqueda con IA**: El [assistant](/es/assistant/index) responde preguntas utilizando el contenido de tu base de conocimientos, para que las personas encuentren respuestas sin saber exactamente dónde buscar. -* **Integraciones con Slack**: Añade el assistant a [Slack](/es/ai/slack-bot) para que tu equipo pueda hacer preguntas y usa el [agent](/es/agent/slack) para capturar conocimiento a partir de las conversaciones. +* **Integraciones con Slack**: Añade el [agent](/es/agent/slack) a Slack para hacer preguntas y capturar conocimiento a partir de las conversaciones. * **Contribuciones con baja barrera de entrada**: El [web editor](/es/editor) y el [agent](/es/agent/index) permiten que cualquier miembro de tu equipo actualice el contenido sin aprender Git o Markdown. * **Autenticación integrada**: Controla el acceso con [SSO u OAuth](/es/deploy/authentication-setup) y usa [groups](/es/deploy/authentication-setup#control-access-with-groups) para mostrar contenido diferente a distintos equipos. diff --git a/es/reference/concepts.mdx b/es/reference/concepts.mdx new file mode 100644 index 0000000000..5f822aeffb --- /dev/null +++ b/es/reference/concepts.mdx @@ -0,0 +1,109 @@ +--- +title: "Conceptos" +description: "Entiende cómo Mintlify conecta tu organización, el repositorio de documentación, los flujos de edición, los despliegues y las funciones de IA." +keywords: ["conceptos", "cómo funciona Mintlify", "repositorio", "despliegue", "publicación", "IA"] +--- + +Mintlify convierte el contenido de un repositorio de Git en un sitio de documentación. Puedes trabajar desde el editor en tu navegador, tu entorno de desarrollo local o pedirle instrucciones al agente de Mintlify en Slack. Los tres flujos de trabajo actualizan el mismo repositorio. Mintlify convierte el contenido de tu repositorio en experiencias optimizadas para personas y agentes. + +```mermaid +flowchart LR + Editors["Browser editors, local editors, and Mintlify agent"] --> Repo[("Documentation repository")] + Repo --> Build["Build and deployment"] + Build --> Site["Live documentation site"] + Site --> Readers["People"] + Site --> AI["AI agents"] +``` + +
+ ## Organizaciones, despliegues y sitios +
+ +Una **organización** es el espacio de trabajo para tu equipo. Contiene a tus miembros, la configuración a nivel de organización y uno o más despliegues. + +Un **despliegue** es un proyecto de documentación en tu organización. Conecta un repositorio, un directorio de contenido y una rama de despliegue con un sitio publicado. Una organización puede tener varios despliegues para productos o propiedades de documentación distintos. + +Un **sitio en vivo** es el resultado publicado de un despliegue. Mintlify proporciona una URL `.mintlify.site` de forma predeterminada. Puedes conectar un [dominio personalizado](/es/customize/custom-domain) para tu sitio. Los sitios incluyen tu contenido, navegación, búsqueda y cualquier función que habilites, como el asistente o el playground de la API. + + + La documentación a veces utiliza **proyecto** como un nombre general para un despliegue y su repositorio, configuración y sitio conectados. + + +
+ ## El repositorio es la fuente de verdad +
+ +El repositorio de tu documentación contiene los archivos que definen tu sitio. Mintlify lee estos archivos durante cada build. + +- Las **páginas** son archivos `.mdx`. Cada página contiene contenido y metadatos en el frontmatter. +- `docs.json` es el archivo de configuración obligatorio. Controla la navegación, la apariencia, las integraciones, la configuración de la API y otros comportamientos globales del sitio. +- Los **recursos** incluyen imágenes, vídeos, fuentes y archivos descargables a los que hacen referencia tus páginas. +- Las **especificaciones de API** pueden generar páginas de referencia de API y playgrounds interactivos a partir de esquemas OpenAPI, AsyncAPI o GraphQL. +- Los **archivos reutilizables** incluyen fragmentos y componentes personalizados de React que las páginas pueden importar. + +Tu repositorio puede contener archivos no publicados. Una página aparece en la navegación del sitio solo cuando la referencias en la navegación de tu [`docs.json`](/es/organize/navigation); de lo contrario, permanece oculta. Las [páginas ocultas](/es/organize/hidden-pages) solo son accesibles mediante un enlace directo. + +
+ ## Las páginas y la navegación son independientes +
+ +Una **página** proporciona el contenido en una URL. Su [frontmatter](/es/organize/pages) controla los metadatos y el comportamiento a nivel de página, incluidos su título, descripción, icono y diseño. + +La **navegación** determina cómo los lectores se desplazan por las páginas. Configura la navegación en tu archivo `docs.json` usando elementos como grupos, pestañas, menús desplegables, productos, versiones e idiomas. La ruta del archivo identifica una página y su posición en `docs.json` determina dónde aparece en la navegación. + +Esta separación te permite reorganizar la experiencia del lector sin mover archivos. También te permite excluir páginas de utilidad de la navegación mientras las mantienes disponibles por URL. + +
+ ## Editar y publicar son etapas diferentes +
+ +Puedes editar el mismo contenido mediante dos flujos de trabajo principales. + +| Flujo de trabajo | Dónde editas | Cómo llegan los cambios a Git | Cómo previsualizas | +| --- | --- | --- | --- | +| Editor | Panel de Mintlify en tu navegador | El editor crea commits y puede abrir solicitudes de extracción | Vista previa en vivo en el editor | +| Desarrollo local | Tu editor preferido | Haces commit y push con Git | Comando de CLI `mint dev` | + +En el editor, los cambios se **guardan** automáticamente, pero no actualizan de inmediato tu repositorio ni tu sitio en vivo. Cuando **publicas**, el editor escribe los cambios en Git. Lo que ocurre a continuación depende de tu rama actual y de la configuración de protección de rama. + +- En la **rama de despliegue**, publicar puede activar directamente un build del sitio en vivo. +- En una **rama de funcionalidad**, publicar puede guardar los cambios en la rama o crear una solicitud de extracción para su revisión. +- Un **despliegue de vista previa** renderiza una solicitud de extracción en una URL temporal para que los revisores puedan inspeccionar el resultado antes de fusionarla. +- Fusionar una solicitud de extracción en la rama de despliegue activa un despliegue de producción. + +Consulta [Ramas y publicación](/es/editor/branching-and-publishing) para conocer el flujo de trabajo completo. + +
+ ## Un build convierte los archivos fuente en experiencias para el lector +
+ +Cuando el contenido llega a la rama de despliegue, Mintlify valida el proyecto, renderiza las páginas y despliega el sitio. El mismo contenido fuente admite varias formas de encontrar y consumir información: + +- El sitio de documentación renderiza páginas para personas en escritorio y móvil. +- La búsqueda indexa el sitio para que los lectores puedan encontrar las páginas relevantes. +- El asistente responde preguntas a partir de la documentación y cita sus fuentes. +- Las versiones en Markdown de las páginas, `llms.txt` y `skill.md` ayudan a las herramientas de IA a entender el contenido. +- Un servidor MCP público permite que las herramientas de IA compatibles recuperen la documentación como contexto estructurado. + +Ejecuta [`mint validate`](/es/cli/commands#mint-validate) y [`mint broken-links`](/es/cli/commands#mint-broken-links) antes de publicar para detectar problemas comunes de forma local. + +
+ ## Las funciones de IA de Mintlify tienen roles distintos +
+ +Mintlify ofrece funciones de IA independientes para leer, escribir, automatizar y acceder a herramientas externas. + +| Función | Utilizado por | Propósito | Modifica el contenido | +| --- | --- | --- | --- | +| [Assistant](/es/assistant) | Lectores de la documentación | Responde preguntas a partir de tu contenido | No | +| [Agent](/es/agent) | Mantenedores de la documentación | Investiga y propone actualizaciones de contenido o configuración | Sí | +| [Automatizaciones](/es/automations/index) | Mantenedores de la documentación | Ejecuta el agente desde una programación, una actualización del repositorio o un evento de integración | Sí | +| [Servidor MCP de búsqueda](/es/ai/model-context-protocol) | Agentes | Recupera contexto de un sitio de documentación publicado | No | +| [Servidor MCP de administración](/es/ai/mintlify-mcp) | Agentes | Lee y actualiza despliegues mediante herramientas autenticadas | Sí | +| [Mintlify Index](/es/search-index) | Agentes | Recupera contexto técnico actualizado de todos los sitios públicos de Mintlify y de la web | No | + +
+ ## Aprende la terminología +
+ +Consulta el [glosario](/es/reference/glossary) para conocer las definiciones de los términos de Mintlify, Git, publicación, navegación, API e IA que se utilizan a lo largo de la documentación. diff --git a/es/reference/glossary.mdx b/es/reference/glossary.mdx new file mode 100644 index 0000000000..f24392f863 --- /dev/null +++ b/es/reference/glossary.mdx @@ -0,0 +1,369 @@ +--- +title: "Glosario" +description: "Encuentra definiciones de terminología de Mintlify sobre producto, contenido, navegación, despliegue, Git, API e IA." +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). + +
+## A +
+ +
+### Admin MCP server +
+ +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). + +
+### Agente +
+ +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). + +
+### Anchor +
+ +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). + +
+### Assistant +
+ +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). + +
+### Automatización +
+ +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). + +
+## B +
+ +
+### Rama +
+ +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). + +
+### Build +
+ +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. + +
+## C +
+ +
+### Commit +
+ +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). + +
+### Componente +
+ +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). + +
+### Directorio de contenido +
+ +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). + +
+### Repositorio de contexto +
+ +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. + +
+### Créditos +
+ +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). + +
+### Dominio personalizado +
+ +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). + +
+## D +
+ +
+### Dashboard +
+ +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. + +
+### Despliegue +
+ +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. + +
+### Rama de despliegue +
+ +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). + +
+### `docs.json` +
+ +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). + + + +Una estructura de navegación de nivel superior que agrupa secciones relacionadas en un menú. Consulta [Dropdowns](/es/organize/navigation#dropdowns). + +
+## E +
+ +
+### Editor +
+ +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). + +
+## F +
+ +
+### Rama de funcionalidad +
+ +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. + +
+### Frontmatter +
+ +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). + +
+## G +
+ +
+### Grupo +
+ +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). + +
+## I +
+ +
+### Índice +
+ +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). + +
+### Integración +
+ +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. + +
+## L +
+ +
+### Idioma +
+ +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). + +
+### Vista previa en vivo +
+ +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/live-preview). + +
+### Sitio en producción +
+ +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. + +
+### `llms.txt` +
+ +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). + +
+## M +
+ +
+### Markdown +
+ +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. + +
+### MDX +
+ +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. + +
+### Merge +
+ +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. + +
+### Model Context Protocol (MCP) +
+ +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. + +
+## N +
+ + + +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). + +
+## O +
+ +
+### OpenAPI +
+ +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). + +
+### Organización +
+ +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. + +
+## P +
+ +
+### Página +
+ +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). + +
+### Despliegue de vista previa +
+ +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). + +
+### Producto +
+ +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). + +
+### Proyecto +
+ +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. + +
+### Publicar +
+ +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. + +
+### Pull request +
+ +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**. + +
+## R +
+ +
+### Redirección +
+ +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). + +
+### Repositorio +
+ +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. + +
+### Fragmento reutilizable +
+ +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). + +
+## S +
+ +
+### `skill.md` +
+ +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). + +
+### Repositorio fuente +
+ +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. + +
+## T +
+ +
+### Pestaña +
+ +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). + +
+### Tema +
+ +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). + +
+## V +
+ +
+### Versión +
+ +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). diff --git a/fr.json b/fr.json index 47ae932bed..d3387a8b73 100644 --- a/fr.json +++ b/fr.json @@ -5,11 +5,11 @@ "groups": [ { "group": "Prise en main", - "icon": "rocket", "boost": 2, "pages": [ "fr/index", "fr/quickstart", + "fr/ai-native", { "group": "CLI", "root": "fr/cli/index", @@ -19,94 +19,32 @@ "fr/cli/commands" ] }, - "fr/ai-native" - ] - }, - { - "group": "Organiser", - "icon": "map", - "pages": [ - { - "group": "Paramètres globaux", - "root": "fr/organize/settings", - "pages": [ - "fr/organize/settings-appearance", - "fr/organize/settings-structure", - "fr/organize/settings-api", - "fr/organize/settings-integrations", - "fr/organize/settings-seo", - "fr/organize/settings-reference" - ] - }, - "fr/organize/navigation", - "fr/organize/pages", - "fr/organize/hidden-pages", - "fr/organize/related-pages", - "fr/organize/mintignore" - ] - }, - { - "group": "Personnaliser", - "icon": "paint-bucket", - "pages": [ - "fr/customize/custom-domain", - "fr/customize/themes", - "fr/customize/fonts", - "fr/customize/custom-scripts", - "fr/customize/react-components", - "fr/customize/custom-404-page" + "fr/migration" ] }, { "group": "Créer du contenu", - "icon": "pen-line", "pages": [ { - "group": "Éditeur web", + "group": "Pages", "pages": [ - "fr/editor/index", - "fr/editor/tutorial", - "fr/editor/git-essentials", - "fr/editor/pages", - "fr/editor/media", - "fr/editor/navigation", - "fr/editor/live-preview", - "fr/editor/branching-and-publishing", - "fr/editor/publish", - "fr/editor/comments", - "fr/editor/suggestions", - "fr/editor/agent", - "fr/editor/configurations", - "fr/editor/settings", - "fr/editor/keyboard-shortcuts" - ] - }, - "fr/create/text", - "fr/create/code", - { - "group": "Assistant IA", - "pages": [ - "fr/agent/index", - "fr/agent/slack", - "fr/agent/customize", - "fr/agent/effective-prompts", - "fr/agent/workflows" + "fr/organize/pages", + "fr/organize/hidden-pages", + "fr/organize/related-pages" ] }, { - "group": "Automatisations", + "group": "Mise en forme", "pages": [ - "fr/automations/index", - "fr/automations/reference", - "fr/automations/manage", - "fr/automations/integrations", - "fr/automations/create" + "fr/create/text", + "fr/create/code", + "fr/create/list-table" ] }, { "group": "Composants", + "root": "fr/components/index", "pages": [ - "fr/components/index", "fr/components/accordions", "fr/components/badge", "fr/components/banner", @@ -131,164 +69,280 @@ "fr/components/tree", "fr/components/update", "fr/components/view", - "fr/components/visibility" + "fr/components/visibility", + "fr/customize/react-components" + ] + }, + { + "group": "Médias", + "pages": [ + "fr/create/image-embeds", + "fr/create/files" ] }, - "fr/create/image-embeds", - "fr/create/files", - "fr/create/list-table", "fr/create/reusable-snippets", "fr/create/personalization", - "fr/create/redirects", - "fr/create/changelogs" - ] - }, - { - "group": "Documenter des API", - "icon": "file-braces", - "pages": [ - "fr/api-playground/overview", - "fr/api-playground/openapi-setup", - "fr/api-playground/complex-data-types", - "fr/api-playground/adding-sdk-examples", - "fr/api-playground/managing-page-visibility", - "fr/api-playground/multiple-responses", - "fr/api-playground/mdx-setup", - "fr/api-playground/asyncapi-setup", - "fr/api-playground/graphql-setup", - "fr/api-playground/sdk-reference-setup", - "fr/api-playground/troubleshooting" + { + "group": "Éditeur web", + "root": "fr/editor/index", + "pages": [ + "fr/editor/tutorial", + "fr/editor/git-essentials", + "fr/editor/pages", + "fr/editor/navigation", + "fr/editor/live-preview", + "fr/editor/branching-and-publishing", + "fr/editor/comments", + "fr/editor/suggestions", + "fr/editor/agent", + "fr/editor/configurations", + "fr/editor/settings", + "fr/editor/keyboard-shortcuts" + ] + }, + "fr/deploy/ci" ] }, { - "group": "Déployer", - "icon": "boxes", + "group": "Gérer votre site", "pages": [ - "fr/deploy/deployments", - "fr/deploy/preview-deployments", - "fr/deploy/export", { - "group": "Hébergement sur sous-chemin", + "group": "Paramètres globaux", + "root": "fr/organize/settings", + "pages": [ + "fr/organize/settings-appearance", + "fr/organize/settings-structure", + "fr/organize/settings-api", + "fr/organize/settings-integrations", + "fr/organize/settings-seo", + "fr/organize/settings-reference" + ] + }, + "fr/organize/navigation", + "fr/ai/contextual-menu", + "fr/create/redirects", + "fr/organize/mintignore", + { + "group": "Configuration du dépôt", + "pages": [ + "fr/deploy/monorepo", + "fr/deploy/multi-repo" + ] + }, + { + "group": "Personnalisation visuelle", + "pages": [ + "fr/customize/themes", + "fr/customize/fonts", + "fr/customize/custom-scripts", + "fr/customize/custom-404-page" + ] + }, + "fr/optimize/analytics", + "fr/optimize/feedback", + { + "group": "Déploiements", + "root": "fr/deploy/deployments", + "pages": [ + "fr/deploy/preview-deployments", + "fr/deploy/github", + "fr/deploy/ghes", + "fr/deploy/gitlab" + ] + }, + { + "group": "Hébergement", + "root": "fr/customize/custom-domain", "pages": [ - "fr/deploy/docs-subpath", - "fr/deploy/cloudflare", - "fr/deploy/route53-cloudfront", - "fr/deploy/vercel", - "fr/deploy/reverse-proxy", - "fr/deploy/csp-configuration" + { + "group": "Hébergement sur sous-chemin", + "root": "fr/deploy/docs-subpath", + "pages": [ + "fr/deploy/cloudflare", + "fr/deploy/route53-cloudfront", + "fr/deploy/vercel", + "fr/deploy/vercel-external-proxies", + "fr/deploy/reverse-proxy" + ] + }, + "fr/deploy/csp-configuration", + "fr/deploy/self-host", + "fr/deploy/custom-portal" ] }, - "fr/deploy/authentication-setup", { - "group": "Accès au Dashboard", + "group": "Exporter votre site", + "pages": [ + "fr/deploy/export", + "fr/optimize/pdf-exports" + ] + }, + { + "group": "Authentification", + "root": "fr/deploy/authentication-setup", "pages": [ "fr/dashboard/sso", - "fr/dashboard/session-security", - "fr/dashboard/network-access", "fr/dashboard/scim", - "fr/dashboard/permissions", + "fr/dashboard/session-security" + ] + }, + { + "group": "Sécurité", + "pages": [ + "fr/dashboard/network-access", "fr/dashboard/roles", + "fr/dashboard/permissions", "fr/dashboard/audit-logs", "fr/dashboard/security-contact" ] - }, - "fr/deploy/monorepo", - "fr/deploy/multi-repo", - "fr/deploy/vercel-external-proxies", - "fr/deploy/ci", - "fr/deploy/github", - "fr/deploy/ghes", - "fr/deploy/gitlab", - "fr/deploy/gitlab-self-hosted", - "fr/deploy/self-host", - "fr/deploy/custom-portal" + } ] }, { - "group": "Optimisation", - "icon": "wrench", + "group": "Agent", "pages": [ + "fr/agent/index", + "fr/agent/slack", { - "group": "Assistant", - "root": "fr/assistant/index", + "group": "Automatisations", + "root": "fr/automations/index", "pages": [ - "fr/assistant/configure", - "fr/assistant/customize", - "fr/assistant/widget", - "fr/assistant/skills", - "fr/assistant/use" + "fr/automations/create", + "fr/automations/manage", + "fr/automations/integrations", + "fr/automations/reference", + "fr/deploy/gitlab-self-hosted" ] }, - "fr/credits", - "fr/ai/contextual-menu", - "fr/optimize/analytics", - "fr/optimize/feedback", - "fr/ai/llmstxt", - "fr/ai/skillmd", - "fr/ai/model-context-protocol", + "fr/agent/customize", + "fr/agent/effective-prompts", + "fr/agent/use-cases" + ] + }, + { + "group": "Assistant", + "pages": [ + "fr/assistant/index", + "fr/assistant/configure", + "fr/assistant/customize", + "fr/assistant/widget", + "fr/assistant/skills", + "fr/assistant/use" + ] + }, + { + "group": "Contenu adapté aux agents", + "pages": [ "fr/ai/mintlify-mcp", - "fr/optimize/search", { "group": "Mintlify Index", + "root": "fr/search-index/index", "pages": [ - "fr/search-index/index", "fr/search-index/connect", "fr/search-index/mcp" ] }, - "fr/optimize/seo", - "fr/ai/markdown-export", - "fr/optimize/pdf-exports", + "fr/ai/model-context-protocol", + "fr/ai/llmstxt", + "fr/ai/skillmd", + "fr/ai/markdown-export" + ] + }, + { + "group": "Recherche et SEO", + "pages": [ + "fr/optimize/search", + "fr/optimize/seo" + ] + }, + { + "group": "Documenter des API", + "pages": [ + "fr/api-playground/overview", { - "group": "Intégrations", + "group": "Spécifications d'API", "pages": [ + "fr/api-playground/openapi-setup", + "fr/api-playground/asyncapi-setup", + "fr/api-playground/graphql-setup", { - "group": "Analytics", - "pages": [ - "fr/integrations/analytics/overview", - "fr/integrations/analytics/amplitude", - "fr/integrations/analytics/clarity", - "fr/integrations/analytics/clearbit", - "fr/integrations/analytics/fathom", - "fr/integrations/analytics/google-analytics", - "fr/integrations/analytics/google-tag-manager", - "fr/integrations/analytics/heap", - "fr/integrations/analytics/hightouch", - "fr/integrations/analytics/hotjar", - "fr/integrations/analytics/logrocket", - "fr/integrations/analytics/mixpanel", - "fr/integrations/analytics/pirsch", - "fr/integrations/analytics/plausible", - "fr/integrations/analytics/posthog", - "fr/integrations/analytics/segment" - ] - }, - { - "group": "SDKs", - "pages": [ - "fr/integrations/sdks/speakeasy", - "fr/integrations/sdks/stainless" - ] - }, - { - "group": "Assistance", - "pages": [ - "fr/integrations/support/overview", - "fr/integrations/support/intercom", - "fr/integrations/support/front" - ] - }, - { - "group": "Confidentialité", + "group": "Configuration de la référence SDK", + "root": "fr/api-playground/sdk-reference-setup", "pages": [ - "fr/integrations/privacy/overview", - "fr/integrations/privacy/osano", - "fr/integrations/privacy/transcend" + "fr/api-playground/adding-sdk-examples" ] } ] + }, + { + "group": "Pages d'endpoint", + "pages": [ + "fr/api-playground/complex-data-types", + "fr/api-playground/multiple-responses", + "fr/api-playground/managing-page-visibility", + "fr/api-playground/mdx-setup" + ] + }, + "fr/api-playground/troubleshooting" + ] + }, + { + "group": "Intégrations", + "pages": [ + { + "group": "Analytics", + "root": "fr/integrations/analytics/overview", + "pages": [ + "fr/integrations/analytics/adobe", + "fr/integrations/analytics/amplitude", + "fr/integrations/analytics/clarity", + "fr/integrations/analytics/clearbit", + "fr/integrations/analytics/fathom", + "fr/integrations/analytics/google-analytics", + "fr/integrations/analytics/google-tag-manager", + "fr/integrations/analytics/heap", + "fr/integrations/analytics/hightouch", + "fr/integrations/analytics/hotjar", + "fr/integrations/analytics/logrocket", + "fr/integrations/analytics/mixpanel", + "fr/integrations/analytics/pirsch", + "fr/integrations/analytics/plausible", + "fr/integrations/analytics/posthog", + "fr/integrations/analytics/segment" + ] + }, + { + "group": "SDKs", + "pages": [ + "fr/integrations/sdks/speakeasy", + "fr/integrations/sdks/stainless" + ] + }, + { + "group": "Assistance", + "root": "fr/integrations/support/overview", + "pages": [ + "fr/integrations/support/intercom", + "fr/integrations/support/front" + ] + }, + { + "group": "Confidentialité", + "root": "fr/integrations/privacy/overview", + "pages": [ + "fr/integrations/privacy/osano", + "fr/integrations/privacy/transcend" + ] } ] + }, + { + "group": "Référence", + "pages": [ + "fr/reference/concepts", + "fr/reference/glossary", + "fr/credits" + ] } ] }, @@ -297,14 +351,12 @@ "groups": [ { "group": "Référence de l’API", - "icon": "file-braces", "pages": [ "fr/api/introduction" ] }, { "group": "Administration", - "icon": "activity", "pages": [ "fr/api/update/trigger", "fr/api/update/status", @@ -315,7 +367,6 @@ }, { "group": "Agent", - "icon": "pen-line", "pages": [ "fr/api/agent/v2/create-agent-job", "fr/api/agent/v2/get-agent-job", @@ -324,14 +375,12 @@ }, { "group": "Assistant", - "icon": "bot-message-square", "pages": [ "fr/api/assistant/create-assistant-message-v2" ] }, { "group": "Recherche", - "icon": "search", "pages": [ "fr/api/assistant/search", "fr/api/assistant/get-page-content" @@ -339,7 +388,6 @@ }, { "group": "Mintlify Index", - "icon": "library", "pages": [ "fr/api/search-index/introduction", "fr/api/search-index/context", @@ -349,16 +397,18 @@ }, { "group": "Analytics", - "icon": "chart-line", "pages": [ "fr/api/analytics/feedback", + "fr/api/analytics/feedback-by-page", "fr/api/analytics/assistant-conversations", - "fr/api/analytics/assistant-caller-stats" + "fr/api/analytics/assistant-caller-stats", + "fr/api/analytics/searches", + "fr/api/analytics/views", + "fr/api/analytics/visitors" ] }, { - "group": "Exportation statique", - "icon": "package", + "group": "Export statique", "pages": [ "fr/api/static-export/start-job", "fr/api/static-export/get-job-status", @@ -368,11 +418,10 @@ ] }, { - "tab": "journal des modifications", + "tab": "Journal des modifications", "groups": [ { - "group": "journal des modifications", - "icon": "calendar", + "group": "Journal des modifications", "boost": 0.5, "pages": [ "fr/changelog" @@ -393,7 +442,7 @@ "description": "Guides pratiques pour les tâches courantes et les bonnes pratiques.", "groups": [ { - "group": "Vue d'ensemble", + "group": "Aperçu", "icon": "book-open", "pages": [ "fr/guides/index", @@ -415,7 +464,7 @@ ] }, { - "group": "Documentation de l’API", + "group": "Documentation d'API", "icon": "file-braces", "pages": [ "fr/guides/migrating-from-mdx" @@ -426,6 +475,7 @@ "icon": "trophy", "pages": [ "fr/guides/accessibility", + "fr/create/changelogs", "fr/guides/content-types", "fr/guides/content-templates", "fr/guides/custom-layouts", @@ -434,7 +484,6 @@ "fr/guides/linking", "fr/guides/maintenance", "fr/guides/media", - "fr/migration", "fr/guides/navigation", "fr/guides/seo", "fr/guides/style-and-tone", @@ -450,7 +499,7 @@ ] }, { - "group": "Cas d’utilisation", + "group": "Cas d'usage", "icon": "blocks", "pages": [ "fr/guides/developer-documentation", diff --git a/fr/guides/knowledge-base.mdx b/fr/guides/knowledge-base.mdx index 1d379fcf9a..cf2a07b6bf 100644 --- a/fr/guides/knowledge-base.mdx +++ b/fr/guides/knowledge-base.mdx @@ -10,7 +10,7 @@ Une base de connaissances interne aide votre équipe à trouver des réponses et Mintlify fournit l'infrastructure pour des bases de connaissances auxquelles toute votre équipe peut contribuer. * **Recherche optimisée par l'IA** : L'[assistant](/fr/assistant/index) répond aux questions en utilisant le contenu de votre base de connaissances, afin que chacun puisse trouver des réponses sans savoir exactement où chercher. -* **Intégrations Slack** : Ajoutez l'assistant à [Slack](/fr/ai/slack-bot) pour que votre équipe puisse poser des questions et utilisez l'[agent](/fr/agent/slack) pour capturer les connaissances issues des conversations. +* **Intégrations Slack** : Ajoutez l'[agent](/fr/agent/slack) à Slack pour poser des questions et capturer les connaissances issues des conversations. * **Contributions simplifiées** : Le [web editor](/fr/editor) et l'[agent](/fr/agent/index) permettent à n'importe quel membre de votre équipe de mettre à jour le contenu sans apprendre Git ou Markdown. * **Authentification intégrée** : Contrôlez l'accès avec [SSO ou OAuth](/fr/deploy/authentication-setup), et utilisez les [groupes](/fr/deploy/authentication-setup#control-access-with-groups) pour afficher des contenus différents selon les équipes. diff --git a/fr/reference/concepts.mdx b/fr/reference/concepts.mdx new file mode 100644 index 0000000000..c6a38d8b3d --- /dev/null +++ b/fr/reference/concepts.mdx @@ -0,0 +1,109 @@ +--- +title: "Concepts" +description: "Comprenez comment Mintlify relie votre organisation, votre référentiel de documentation, vos workflows d'édition, vos déploiements et vos fonctionnalités d'IA." +keywords: ["concepts", "fonctionnement de Mintlify", "référentiel", "déploiement", "publication", "IA"] +--- + +Mintlify transforme le contenu d'un référentiel Git en un site de documentation. Vous pouvez travailler depuis l'éditeur dans votre navigateur, votre environnement de développement local, ou en interrogeant l'agent Mintlify dans Slack. Ces trois workflows mettent à jour le même référentiel. Mintlify compile le contenu de votre référentiel en expériences optimisées pour les personnes et les agents. + +```mermaid +flowchart LR + Editors["Browser editors, local editors, and Mintlify agent"] --> Repo[("Documentation repository")] + Repo --> Build["Build and deployment"] + Build --> Site["Live documentation site"] + Site --> Readers["People"] + Site --> AI["AI agents"] +``` + +
+ ## Organisations, déploiements et sites +
+ +Une **organisation** est l'espace de travail de votre équipe. Elle contient vos membres, les paramètres au niveau de l'organisation, et un ou plusieurs déploiements. + +Un **déploiement** est un projet de documentation dans votre organisation. Il connecte un référentiel, un répertoire de contenu et une branche de déploiement à un site publié. Une organisation peut avoir plusieurs déploiements pour des produits distincts ou différentes propriétés de documentation. + +Un **site en ligne** est le résultat publié d'un déploiement. Mintlify fournit par défaut une URL `.mintlify.site`. Vous pouvez connecter un [domaine personnalisé](/fr/customize/custom-domain) à votre site. Les sites incluent votre contenu, votre navigation, la recherche et toutes les fonctionnalités que vous activez, comme l'assistant ou le playground d'API. + + + La documentation utilise parfois **projet** comme nom générique pour un déploiement et son référentiel, sa configuration et son site associés. + + +
+ ## Le référentiel est la source de vérité +
+ +Votre référentiel de documentation contient les fichiers qui définissent votre site. Mintlify lit ces fichiers à chaque build. + +- Les **pages** sont des fichiers `.mdx`. Chaque page contient du contenu et des métadonnées de frontmatter. +- `docs.json` est le fichier de configuration obligatoire. Il contrôle la navigation, l'apparence, les intégrations, les paramètres d'API et d'autres comportements applicables à l'ensemble du site. +- Les **ressources** incluent les images, vidéos, polices et fichiers téléchargeables référencés par vos pages. +- Les **spécifications d'API** peuvent générer des pages de référence d'API et des playgrounds interactifs à partir de schémas OpenAPI, AsyncAPI ou GraphQL. +- Les **fichiers réutilisables** incluent les snippets et les composants React personnalisés que les pages peuvent importer. + +Votre référentiel peut contenir des fichiers non publiés. Une page apparaît dans la navigation du site uniquement lorsque vous la référencez dans la navigation de votre [`docs.json`](/fr/organize/navigation), sinon elle est masquée. Les [pages masquées](/fr/organize/hidden-pages) ne sont accessibles que par un lien direct. + +
+ ## Les pages et la navigation sont distinctes +
+ +Une **page** fournit le contenu à une URL. Son [frontmatter](/fr/organize/pages) contrôle les métadonnées et le comportement au niveau de la page, notamment son titre, sa description, son icône et sa mise en page. + +La **navigation** détermine la façon dont les lecteurs se déplacent d'une page à l'autre. Configurez la navigation dans votre fichier `docs.json` en utilisant des éléments tels que les groupes, les onglets, les listes déroulantes, les produits, les versions et les langues. Le chemin du fichier identifie une page et sa position dans `docs.json` détermine son emplacement dans la navigation. + +Cette séparation vous permet de réorganiser l'expérience du lecteur sans déplacer les fichiers. Elle vous permet également d'exclure les pages utilitaires de la navigation tout en les gardant accessibles par URL. + +
+ ## L'édition et la publication sont des étapes distinctes +
+ +Vous pouvez modifier le même contenu via deux workflows principaux. + +| Workflow | Où vous éditez | Comment les modifications parviennent à Git | Comment vous prévisualisez | +| --- | --- | --- | --- | +| Éditeur | Dashboard Mintlify dans votre navigateur | L'éditeur crée des commits et peut ouvrir des pull requests | Aperçu en direct dans l'éditeur | +| Développement local | Votre éditeur préféré | Vous validez et poussez avec Git | Commande CLI `mint dev` | + +Dans l'éditeur, les modifications sont **enregistrées** automatiquement mais ne mettent pas immédiatement à jour votre référentiel ou votre site en ligne. Lorsque vous **publiez**, l'éditeur écrit les modifications dans Git. Ce qui se passe ensuite dépend de votre branche actuelle et des paramètres de protection de branche. + +- Sur la **branche de déploiement**, la publication peut déclencher directement un build du site en ligne. +- Sur une **branche de fonctionnalité**, la publication peut enregistrer les modifications sur la branche ou créer une pull request pour relecture. +- Un **déploiement de prévisualisation** rend une pull request sur une URL temporaire afin que les relecteurs puissent inspecter le résultat avant la fusion. +- La fusion d'une pull request dans la branche de déploiement déclenche un déploiement en production. + +Consultez [Branching et publication](/fr/editor/branching-and-publishing) pour le workflow complet. + +
+ ## Un build transforme les fichiers source en expériences pour les lecteurs +
+ +Lorsque le contenu atteint la branche de déploiement, Mintlify valide le projet, rend les pages et déploie le site. Le même contenu source prend en charge plusieurs manières de trouver et de consommer l'information : + +- Le site de documentation affiche les pages pour les personnes sur ordinateur et mobile. +- La recherche indexe le site afin que les lecteurs puissent trouver les pages pertinentes. +- L'assistant répond aux questions à partir de la documentation et cite ses sources. +- Les versions Markdown des pages, `llms.txt` et `skill.md` aident les outils d'IA à comprendre le contenu. +- Un serveur MCP public permet aux outils d'IA compatibles de récupérer la documentation sous forme de contexte structuré. + +Exécutez [`mint validate`](/fr/cli/commands#mint-validate) et [`mint broken-links`](/fr/cli/commands#mint-broken-links) avant de publier pour détecter les problèmes courants en local. + +
+ ## Les fonctionnalités d'IA de Mintlify ont des rôles différents +
+ +Mintlify propose des fonctionnalités d'IA distinctes pour la lecture, l'écriture, l'automatisation et l'accès aux outils externes. + +| Fonctionnalité | Utilisée par | Objectif | Modifie le contenu | +| --- | --- | --- | --- | +| [Assistant](/fr/assistant) | Lecteurs de la documentation | Répond aux questions à partir de votre contenu | Non | +| [Agent](/fr/agent) | Mainteneurs de la documentation | Recherche et propose des mises à jour de contenu ou de configuration | Oui | +| [Automatisations](/fr/automations/index) | Mainteneurs de la documentation | Exécute l'agent selon un planning, une mise à jour du référentiel ou un événement d'intégration | Oui | +| [Serveur MCP de recherche](/fr/ai/model-context-protocol) | Agents | Récupère le contexte à partir d'un site de documentation publié | Non | +| [Serveur MCP admin](/fr/ai/mintlify-mcp) | Agents | Lit et met à jour les déploiements via des outils authentifiés | Oui | +| [Mintlify Index](/fr/search-index) | Agents | Récupère le contexte technique actuel sur tous les sites publics Mintlify et sur le web | Non | + +
+ ## Apprenez la terminologie +
+ +Consultez le [glossaire](/fr/reference/glossary) pour les définitions des termes Mintlify, Git, de publication, de navigation, d'API et d'IA utilisés dans l'ensemble de la documentation. diff --git a/fr/reference/glossary.mdx b/fr/reference/glossary.mdx new file mode 100644 index 0000000000..29bc9984dd --- /dev/null +++ b/fr/reference/glossary.mdx @@ -0,0 +1,369 @@ +--- +title: "Glossaire" +description: "Trouvez les définitions des termes Mintlify liés au produit, au contenu, à la navigation, au déploiement, à Git, aux API et à l'IA." +keywords: ["glossaire", "termes", "définitions", "terminologie"] +--- + +Utilisez ce glossaire comme référence rapide pour les termes utilisés dans Mintlify et dans l'ensemble de cette documentation. Pour un aperçu de l'articulation des différentes parties, consultez [Concepts](/fr/reference/concepts). + +
+## A +
+ +
+### Admin MCP server +
+ +Un serveur [Model Context Protocol](#model-context-protocol-mcp) authentifié qui permet aux outils d'IA autorisés de lire et de mettre à jour le contenu et les paramètres sur un ou plusieurs déploiements d'une organisation. Les modifications se font sur une branche et nécessitent une pull request pour être fusionnées. Consultez [Admin MCP server](/fr/ai/mintlify-mcp). + +
+### Agent +
+ +Un outil d'IA destiné aux mainteneurs de documentation qui recherche, rédige, valide et publie des modifications proposées. L'agent peut ouvrir une pull request ou commiter sur la branche de déploiement, selon votre configuration. Consultez [Agent](/fr/agent). + +
+### Ancre +
+ +Un lien de navigation persistant de premier niveau vers une destination interne ou externe. Les ancres constituent l'un des principaux schémas de navigation disponibles dans `docs.json`. Consultez [Ancres](/fr/organize/navigation#anchors). + +
+### Assistant +
+ +Une interface d'IA destinée aux lecteurs de la documentation qui répond aux questions à partir de votre contenu. Il cite les pages pertinentes et peut diriger les utilisateurs directement vers le contenu approprié. L'assistant ne modifie pas votre documentation. Consultez [Assistant](/fr/assistant). + +
+### Automatisation +
+ +Une tâche d'agent configurée qui s'exécute selon un calendrier, après une mise à jour du dépôt ou en réponse à un événement provenant d'une intégration connectée. Consultez [Automations](/fr/automations/index). + +
+## B +
+ +
+### Branche +
+ +Une ligne de travail distincte dans un dépôt Git. Utilisez les branches pour effectuer et relire des modifications sans affecter le site en production. Consultez [Concepts Git](/fr/guides/git-concepts#branch). + +
+### Build +
+ +Le processus qui valide les fichiers de votre projet et les transforme en un site de documentation déployable. Un build peut produire le site en production ou un déploiement de prévisualisation. + +
+## C +
+ +
+### Commit +
+ +Un instantané enregistré des modifications dans un dépôt Git. Publier depuis l'éditeur web crée un commit. Consultez [Concepts Git](/fr/guides/git-concepts#commit). + +
+### Composant +
+ +Un élément MDX réutilisable pour présenter du contenu structuré ou interactif, tel qu'une carte, un encart, un accordéon, un onglet ou un groupe de code. Consultez [Composants](/fr/components). + +
+### Répertoire de contenu +
+ +Le répertoire d'un dépôt qui contient `docs.json` et les fichiers d'un déploiement Mintlify. Il peut s'agir de la racine du dépôt ou d'un sous-répertoire configuré, comme `docs/` dans un monorepo. Consultez [Configuration monorepo](/fr/deploy/monorepo). + +
+### Dépôt de contexte +
+ +Un dépôt supplémentaire que l'agent peut consulter pour obtenir des informations de fond lorsqu'il effectue une tâche. Un dépôt de contexte ne fait pas partie du site de documentation. + +
+### Crédits +
+ +Des unités qui mesurent l'utilisation des fonctionnalités d'IA de Mintlify. Les crédits sont mutualisés au sein d'une organisation et partagés par ses déploiements et ses membres. Consultez [Crédits](/fr/credits). + +
+### Domaine personnalisé +
+ +Un domaine, sous-domaine ou sous-chemin que vous connectez à un site Mintlify au lieu d'utiliser son adresse `.mintlify.site` par défaut. Consultez [Domaine personnalisé](/fr/customize/custom-domain). + +
+## D +
+ +
+### Tableau de bord +
+ +L'application Mintlify authentifiée où votre équipe édite le contenu, surveille les déploiements, gère les membres et configure les paramètres du projet et de l'organisation. + +
+### Déploiement +
+ +Un projet de documentation au sein d'une organisation Mintlify. Un déploiement connecte le contenu source et une branche de déploiement à un site en production. Le terme peut également désigner un build spécifique en cours de publication. + +
+### Branche de déploiement +
+ +La branche Git utilisée pour construire le site en production, généralement `main`. Les modifications poussées ou fusionnées dans cette branche déclenchent un déploiement en production. Consultez [Branche de déploiement](/fr/guides/git-concepts#deployment-branch). + +
+### `docs.json` +
+ +Le fichier de configuration requis pour un site Mintlify. Il contrôle la navigation, l'apparence, les intégrations, les paramètres d'API, les redirections et d'autres comportements globaux. Consultez [`docs.json`](/fr/organize/settings). + + + +Une structure de navigation de premier niveau qui regroupe des sections associées dans un menu. Consultez [Menus déroulants](/fr/organize/navigation#dropdowns). + +
+## E +
+ +
+### Éditeur +
+ +L'éditeur intégré au navigateur dans le tableau de bord Mintlify. Il offre l'édition collaborative, la sauvegarde automatique, les prévisualisations en direct, la synchronisation Git et les flux de publication. Consultez [Vue d'ensemble de l'éditeur](/fr/editor). + +
+## F +
+ +
+### Branche de fonctionnalité +
+ +Toute branche autre que la branche de déploiement que vous utilisez pour préparer des modifications. Les branches de fonctionnalité maintiennent le travail inachevé séparé du site en production. + +
+### Frontmatter +
+ +Métadonnées YAML au début d'une page MDX, encadrées par des lignes `---`. Le frontmatter contrôle des propriétés telles que le titre de la page, la description, l'icône et la mise en page. Consultez [Pages](/fr/organize/pages). + +
+## G +
+ +
+### Groupe +
+ +Une collection étiquetée de pages ou de groupes imbriqués dans la barre latérale. Les groupes organisent le contenu associé au sein d'une section de navigation. Consultez [Groupes](/fr/organize/navigation#groups). + +
+## I +
+ +
+### Index +
+ +Un service de recherche pour les agents de codage qui récupère le contexte technique à jour à partir de la documentation maintenue par les éditeurs et du Web via un serveur MCP ou une API REST. Consultez [Index](/fr/search-index). + +
+### Intégration +
+ +Une connexion entre Mintlify et un autre service. Les intégrations peuvent fournir des analyses, un chat, des contrôles de confidentialité, des exemples de SDK, du contexte d'automatisation ou des déclencheurs d'automatisation. + +
+## L +
+ +
+### Langue +
+ +Une version localisée de votre documentation configurée dans la navigation. Les langues créent des routes basées sur la locale et un sélecteur de langue. Consultez [Langues](/fr/organize/navigation#languages). + +
+### Prévisualisation en direct +
+ +Le rendu continuellement mis à jour de vos modifications non publiées dans l'éditeur web. Une prévisualisation en direct n'est pas déployée publiquement. Consultez [Prévisualisation en direct](/fr/editor/live-preview). + +
+### Site en production +
+ +Le site de documentation de production construit à partir de la branche de déploiement et accessible aux lecteurs sur un domaine Mintlify ou personnalisé. + +
+### `llms.txt` +
+ +Un fichier texte généré qui aide les outils d'IA à découvrir les pages les plus utiles d'un site de documentation. `llms-full.txt` inclut le contenu de toutes les pages dans un seul fichier. Consultez [`llms.txt`](/fr/ai/llmstxt). + +
+## M +
+ +
+### Markdown +
+ +Une syntaxe en texte brut permettant de formater du contenu avec des éléments tels que des titres, des listes, des liens et des blocs de code. Les pages Mintlify publiées sont également disponibles en Markdown en ajoutant `.md` à leur URL. + +
+### MDX +
+ +Markdown enrichi par JSX. Mintlify utilise des fichiers de page `.mdx` afin que vous puissiez combiner du Markdown standard avec des composants et des éléments React personnalisés. + +
+### Fusion +
+ +L'opération Git qui combine les modifications d'une branche dans une autre. Fusionner une branche de fonctionnalité dans la branche de déploiement publie ses modifications via un nouveau build. + +
+### Model Context Protocol (MCP) +
+ +Un protocole ouvert qui permet aux applications d'IA de se connecter à des outils et à des sources de données. Mintlify propose un serveur MCP public en lecture seule pour chaque site publié ainsi qu'un serveur MCP d'administration authentifié pour gérer les déploiements. + +
+## N +
+ + + +La hiérarchie que les lecteurs utilisent pour se déplacer dans un site de documentation. Configurez la navigation dans votre fichier `docs.json` avec des pages, des groupes, des onglets, des menus déroulants, des produits, des versions, des langues et des ancres. Consultez [Navigation](/fr/organize/navigation). + +
+## O +
+ +
+### OpenAPI +
+ +Un format standard pour décrire les API HTTP. Mintlify peut générer des pages de points de terminaison, des exemples de requêtes et un playground d'API interactif à partir d'un document OpenAPI. Consultez [Configuration OpenAPI](/fr/api-playground/openapi-setup). + +
+### Organisation +
+ +Un espace de travail Mintlify qui contient les membres de l'équipe, les paramètres au niveau de l'organisation, les crédits partagés et un ou plusieurs déploiements. + +
+## P +
+ +
+### Page +
+ +Un fichier `.mdx` qui est rendu comme une route sur votre site de documentation. Une page combine le frontmatter, le contenu Markdown et des composants optionnels. Consultez [Pages](/fr/organize/pages). + +
+### Déploiement de prévisualisation +
+ +Une version temporaire et partageable d'un site construite à partir d'une pull request ou d'une branche sélectionnée. Elle permet aux relecteurs d'inspecter les modifications avant qu'elles n'atteignent le site en production. Consultez [Déploiements de prévisualisation](/fr/deploy/preview-deployments). + +
+### Produit +
+ +Une structure de navigation de premier niveau permettant de publier de la documentation pour plusieurs produits distincts dans un seul déploiement. Chaque produit a sa propre navigation. Consultez [Produits](/fr/organize/navigation#products). + +
+### Projet +
+ +Un terme général désignant un déploiement Mintlify et son dépôt, sa configuration et son site associés. Dans les paramètres du tableau de bord et les API, **déploiement** est généralement le terme le plus précis. + +
+### Publier +
+ +Écrire les modifications de la documentation dans Git afin qu'elles puissent progresser vers le site en production. Selon la branche et les paramètres de relecture, la publication peut déployer directement, enregistrer un commit sur une branche ou créer une pull request. + +
+### Pull request +
+ +Une proposition de fusion des modifications d'une branche Git dans une autre. Les pull requests prennent en charge la relecture, les discussions, les vérifications automatisées et les déploiements de prévisualisation avant que les modifications n'atteignent la branche de déploiement. GitLab appelle cela une **merge request**. + +
+## R +
+ +
+### Redirection +
+ +Une règle qui envoie les visiteurs d'une URL ancienne ou alternative vers une nouvelle destination. Les redirections préservent le bon fonctionnement des liens lorsque le contenu est déplacé. Consultez [Redirections](/fr/create/redirects). + +
+### Dépôt +
+ +Une collection de fichiers et leur historique Git. Le dépôt de documentation est la source de vérité pour un site Mintlify et contient ses pages, sa configuration et ses ressources. + +
+### Extrait réutilisable +
+ +Contenu stocké dans un fichier séparé et importé dans une ou plusieurs pages MDX. Mettre à jour l'extrait source met à jour chaque page qui l'utilise. Consultez [Extraits réutilisables](/fr/create/reusable-snippets). + +
+## S +
+ +
+### `skill.md` +
+ +Un fichier généré qui décrit les capacités et la documentation d'un produit à destination des agents d'IA. Les utilisateurs peuvent l'installer en tant que compétence d'agent afin d'améliorer les résultats lorsqu'ils travaillent avec le produit. Consultez [`skill.md`](/fr/ai/skillmd). + +
+### Dépôt source +
+ +Le dépôt qui contient le code du produit, les définitions d'API ou d'autres éléments décrits par la documentation. L'agent peut utiliser un dépôt source connecté comme contexte sans publier ses fichiers sur le site de documentation. + +
+## T +
+ +
+### Onglet +
+ +Une section de navigation de premier niveau pour des domaines parallèles de la documentation destinés au même public, tels que les guides et la référence d'API. Consultez [Onglets](/fr/organize/navigation#tabs). + +
+### Thème +
+ +La mise en page de base et le système visuel d'un site de documentation. Un thème contrôle la présentation globale, tandis que les couleurs, les polices, les logos et d'autres paramètres le personnalisent. Consultez [Thèmes](/fr/customize/themes). + +
+## V +
+ +
+### Version +
+ +Une structure de navigation permettant de publier plusieurs versions de la même documentation en parallèle, telles que `v1` et `v2`. Consultez [Versions](/fr/organize/navigation#versions). diff --git a/zh.json b/zh.json index 5b4e6cb318..b7a5c3de71 100644 --- a/zh.json +++ b/zh.json @@ -5,11 +5,11 @@ "groups": [ { "group": "快速入门", - "icon": "rocket", "boost": 2, "pages": [ "zh/index", "zh/quickstart", + "zh/ai-native", { "group": "CLI", "root": "zh/cli/index", @@ -19,91 +19,32 @@ "zh/cli/commands" ] }, - "zh/ai-native" - ] - }, - { - "group": "组织", - "icon": "map", - "pages": [ - { - "group": "全局设置", - "root": "zh/organize/settings", - "pages": [ - "zh/organize/settings-appearance", - "zh/organize/settings-structure", - "zh/organize/settings-api", - "zh/organize/settings-integrations", - "zh/organize/settings-seo", - "zh/organize/settings-reference" - ] - }, - "zh/organize/navigation", - "zh/organize/pages", - "zh/organize/hidden-pages", - "zh/organize/related-pages", - "zh/organize/mintignore" - ] - }, - { - "group": "自定义", - "icon": "paint-bucket", - "pages": [ - "zh/customize/custom-domain", - "zh/customize/themes", - "zh/customize/fonts", - "zh/customize/custom-scripts", - "zh/customize/react-components", - "zh/customize/custom-404-page" + "zh/migration" ] }, { "group": "创建内容", - "icon": "pen-line", "pages": [ { - "group": "Web 编辑器", + "group": "页面", "pages": [ - "zh/editor/index", - "zh/editor/pages", - "zh/editor/media", - "zh/editor/navigation", - "zh/editor/configurations", - "zh/editor/live-preview", - "zh/editor/collaborate", - "zh/editor/comments", - "zh/editor/suggestions", - "zh/editor/publish", - "zh/editor/keyboard-shortcuts", - "zh/editor/settings" + "zh/organize/pages", + "zh/organize/hidden-pages", + "zh/organize/related-pages" ] }, - "zh/create/text", - "zh/create/code", { - "group": "AI 助手", + "group": "格式设置", "pages": [ - "zh/agent/index", - "zh/agent/slack", - "zh/agent/customize", - "zh/agent/effective-prompts", - "zh/agent/workflows" - ] - }, - { - "group": "自动化", - "pages": [ - "zh/automations/index", - "zh/automations/reference", - "zh/automations/manage", - "zh/automations/integrations", - "zh/automations/create" + "zh/create/text", + "zh/create/code", + "zh/create/list-table" ] }, { "group": "组件", + "root": "zh/components/index", "pages": [ - "zh/components/index", "zh/components/accordions", "zh/components/badge", "zh/components/banner", @@ -128,162 +69,280 @@ "zh/components/tree", "zh/components/update", "zh/components/view", - "zh/components/visibility" + "zh/components/visibility", + "zh/customize/react-components" + ] + }, + { + "group": "媒体", + "pages": [ + "zh/create/image-embeds", + "zh/create/files" ] }, - "zh/create/image-embeds", - "zh/create/files", - "zh/create/list-table", "zh/create/reusable-snippets", "zh/create/personalization", - "zh/create/redirects", - "zh/create/changelogs" - ] - }, - { - "group": "编写 API 文档", - "icon": "file-json", - "pages": [ - "zh/api-playground/overview", - "zh/api-playground/openapi-setup", - "zh/api-playground/complex-data-types", - "zh/api-playground/adding-sdk-examples", - "zh/api-playground/managing-page-visibility", - "zh/api-playground/multiple-responses", - "zh/api-playground/mdx-setup", - "zh/api-playground/asyncapi-setup", - "zh/api-playground/graphql-setup", - "zh/api-playground/sdk-reference-setup", - "zh/api-playground/troubleshooting" + { + "group": "Web 编辑器", + "root": "zh/editor/index", + "pages": [ + "zh/editor/tutorial", + "zh/editor/git-essentials", + "zh/editor/pages", + "zh/editor/navigation", + "zh/editor/live-preview", + "zh/editor/branching-and-publishing", + "zh/editor/comments", + "zh/editor/suggestions", + "zh/editor/agent", + "zh/editor/configurations", + "zh/editor/settings", + "zh/editor/keyboard-shortcuts" + ] + }, + "zh/deploy/ci" ] }, { - "group": "部署", - "icon": "boxes", + "group": "管理站点", "pages": [ - "zh/deploy/deployments", - "zh/deploy/preview-deployments", - "zh/deploy/export", { - "group": "子路径托管", + "group": "全局设置", + "root": "zh/organize/settings", + "pages": [ + "zh/organize/settings-appearance", + "zh/organize/settings-structure", + "zh/organize/settings-api", + "zh/organize/settings-integrations", + "zh/organize/settings-seo", + "zh/organize/settings-reference" + ] + }, + "zh/organize/navigation", + "zh/ai/contextual-menu", + "zh/create/redirects", + "zh/organize/mintignore", + { + "group": "存储库设置", + "pages": [ + "zh/deploy/monorepo", + "zh/deploy/multi-repo" + ] + }, + { + "group": "视觉自定义", + "pages": [ + "zh/customize/themes", + "zh/customize/fonts", + "zh/customize/custom-scripts", + "zh/customize/custom-404-page" + ] + }, + "zh/optimize/analytics", + "zh/optimize/feedback", + { + "group": "部署", + "root": "zh/deploy/deployments", + "pages": [ + "zh/deploy/preview-deployments", + "zh/deploy/github", + "zh/deploy/ghes", + "zh/deploy/gitlab" + ] + }, + { + "group": "托管", + "root": "zh/customize/custom-domain", + "pages": [ + { + "group": "子路径托管", + "root": "zh/deploy/docs-subpath", + "pages": [ + "zh/deploy/cloudflare", + "zh/deploy/route53-cloudfront", + "zh/deploy/vercel", + "zh/deploy/vercel-external-proxies", + "zh/deploy/reverse-proxy" + ] + }, + "zh/deploy/csp-configuration", + "zh/deploy/self-host", + "zh/deploy/custom-portal" + ] + }, + { + "group": "导出站点", "pages": [ - "zh/deploy/docs-subpath", - "zh/deploy/cloudflare", - "zh/deploy/route53-cloudfront", - "zh/deploy/vercel", - "zh/deploy/reverse-proxy", - "zh/deploy/csp-configuration" + "zh/deploy/export", + "zh/optimize/pdf-exports" ] }, - "zh/deploy/authentication-setup", { - "group": "控制台访问", + "group": "身份验证", + "root": "zh/deploy/authentication-setup", "pages": [ "zh/dashboard/sso", - "zh/dashboard/session-security", - "zh/dashboard/network-access", "zh/dashboard/scim", - "zh/dashboard/permissions", + "zh/dashboard/session-security" + ] + }, + { + "group": "安全", + "pages": [ + "zh/dashboard/network-access", "zh/dashboard/roles", + "zh/dashboard/permissions", "zh/dashboard/audit-logs", "zh/dashboard/security-contact" ] - }, - "zh/deploy/monorepo", - "zh/deploy/multi-repo", - "zh/deploy/vercel-external-proxies", - "zh/deploy/ci", - "zh/deploy/github", - "zh/deploy/ghes", - "zh/deploy/gitlab", - "zh/deploy/gitlab-self-hosted", - "zh/deploy/self-host", - "zh/deploy/custom-portal" + } ] }, { - "group": "优化", - "icon": "wrench", + "group": "Agent", "pages": [ + "zh/agent/index", + "zh/agent/slack", { - "group": "Assistant", - "root": "zh/assistant/index", + "group": "自动化", + "root": "zh/automations/index", "pages": [ - "zh/assistant/configure", - "zh/assistant/customize", - "zh/assistant/widget", - "zh/assistant/skills", - "zh/assistant/use" + "zh/automations/create", + "zh/automations/manage", + "zh/automations/integrations", + "zh/automations/reference", + "zh/deploy/gitlab-self-hosted" ] }, - "zh/ai/contextual-menu", - "zh/optimize/analytics", - "zh/optimize/feedback", - "zh/ai/llmstxt", - "zh/ai/skillmd", - "zh/ai/model-context-protocol", - "zh/optimize/search-boost", + "zh/agent/customize", + "zh/agent/effective-prompts", + "zh/agent/use-cases" + ] + }, + { + "group": "Assistant", + "pages": [ + "zh/assistant/index", + "zh/assistant/configure", + "zh/assistant/customize", + "zh/assistant/widget", + "zh/assistant/skills", + "zh/assistant/use" + ] + }, + { + "group": "面向 Agent 的内容", + "pages": [ + "zh/ai/mintlify-mcp", { "group": "Mintlify Index", + "root": "zh/search-index/index", "pages": [ - "zh/search-index/index", "zh/search-index/connect", "zh/search-index/mcp" ] }, - "zh/optimize/seo", - "zh/ai/markdown-export", - "zh/optimize/pdf-exports", + "zh/ai/model-context-protocol", + "zh/ai/llmstxt", + "zh/ai/skillmd", + "zh/ai/markdown-export" + ] + }, + { + "group": "搜索与 SEO", + "pages": [ + "zh/optimize/search", + "zh/optimize/seo" + ] + }, + { + "group": "编写 API 文档", + "pages": [ + "zh/api-playground/overview", { - "group": "集成", + "group": "API 规范", "pages": [ + "zh/api-playground/openapi-setup", + "zh/api-playground/asyncapi-setup", + "zh/api-playground/graphql-setup", { - "group": "Analytics", - "pages": [ - "zh/integrations/analytics/overview", - "zh/integrations/analytics/amplitude", - "zh/integrations/analytics/clarity", - "zh/integrations/analytics/clearbit", - "zh/integrations/analytics/fathom", - "zh/integrations/analytics/google-analytics", - "zh/integrations/analytics/google-tag-manager", - "zh/integrations/analytics/heap", - "zh/integrations/analytics/hightouch", - "zh/integrations/analytics/hotjar", - "zh/integrations/analytics/logrocket", - "zh/integrations/analytics/mixpanel", - "zh/integrations/analytics/pirsch", - "zh/integrations/analytics/plausible", - "zh/integrations/analytics/posthog", - "zh/integrations/analytics/segment" - ] - }, - { - "group": "SDK", - "pages": [ - "zh/integrations/sdks/speakeasy", - "zh/integrations/sdks/stainless" - ] - }, - { - "group": "支持", + "group": "SDK 参考设置", + "root": "zh/api-playground/sdk-reference-setup", "pages": [ - "zh/integrations/support/overview", - "zh/integrations/support/intercom", - "zh/integrations/support/front" - ] - }, - { - "group": "隐私", - "pages": [ - "zh/integrations/privacy/overview", - "zh/integrations/privacy/osano", - "zh/integrations/privacy/transcend" + "zh/api-playground/adding-sdk-examples" ] } ] + }, + { + "group": "端点页面", + "pages": [ + "zh/api-playground/complex-data-types", + "zh/api-playground/multiple-responses", + "zh/api-playground/managing-page-visibility", + "zh/api-playground/mdx-setup" + ] + }, + "zh/api-playground/troubleshooting" + ] + }, + { + "group": "集成", + "pages": [ + { + "group": "Analytics", + "root": "zh/integrations/analytics/overview", + "pages": [ + "zh/integrations/analytics/adobe", + "zh/integrations/analytics/amplitude", + "zh/integrations/analytics/clarity", + "zh/integrations/analytics/clearbit", + "zh/integrations/analytics/fathom", + "zh/integrations/analytics/google-analytics", + "zh/integrations/analytics/google-tag-manager", + "zh/integrations/analytics/heap", + "zh/integrations/analytics/hightouch", + "zh/integrations/analytics/hotjar", + "zh/integrations/analytics/logrocket", + "zh/integrations/analytics/mixpanel", + "zh/integrations/analytics/pirsch", + "zh/integrations/analytics/plausible", + "zh/integrations/analytics/posthog", + "zh/integrations/analytics/segment" + ] + }, + { + "group": "SDK", + "pages": [ + "zh/integrations/sdks/speakeasy", + "zh/integrations/sdks/stainless" + ] + }, + { + "group": "支持", + "root": "zh/integrations/support/overview", + "pages": [ + "zh/integrations/support/intercom", + "zh/integrations/support/front" + ] + }, + { + "group": "隐私", + "root": "zh/integrations/privacy/overview", + "pages": [ + "zh/integrations/privacy/osano", + "zh/integrations/privacy/transcend" + ] } ] + }, + { + "group": "参考", + "pages": [ + "zh/reference/concepts", + "zh/reference/glossary", + "zh/credits" + ] } ] }, @@ -292,14 +351,12 @@ "groups": [ { "group": "API 参考", - "icon": "file-braces", "pages": [ "zh/api/introduction" ] }, { "group": "管理", - "icon": "activity", "pages": [ "zh/api/update/trigger", "zh/api/update/status", @@ -309,8 +366,7 @@ ] }, { - "group": "代理", - "icon": "pen-line", + "group": "Agent", "pages": [ "zh/api/agent/v2/create-agent-job", "zh/api/agent/v2/get-agent-job", @@ -318,15 +374,13 @@ ] }, { - "group": "AI 助手", - "icon": "bot-message-square", + "group": "Assistant", "pages": [ "zh/api/assistant/create-assistant-message-v2" ] }, { "group": "搜索", - "icon": "search", "pages": [ "zh/api/assistant/search", "zh/api/assistant/get-page-content" @@ -334,7 +388,6 @@ }, { "group": "Mintlify Index", - "icon": "library", "pages": [ "zh/api/search-index/introduction", "zh/api/search-index/context", @@ -344,16 +397,18 @@ }, { "group": "数据分析", - "icon": "chart-line", "pages": [ "zh/api/analytics/feedback", + "zh/api/analytics/feedback-by-page", "zh/api/analytics/assistant-conversations", - "zh/api/analytics/assistant-caller-stats" + "zh/api/analytics/assistant-caller-stats", + "zh/api/analytics/searches", + "zh/api/analytics/views", + "zh/api/analytics/visitors" ] }, { "group": "静态导出", - "icon": "package", "pages": [ "zh/api/static-export/start-job", "zh/api/static-export/get-job-status", @@ -367,7 +422,6 @@ "groups": [ { "group": "更新日志", - "icon": "calendar", "boost": 0.5, "pages": [ "zh/changelog" @@ -381,7 +435,7 @@ { "item": "学习", "href": "https://learn.mintlify.com/", - "description": "自定进度的课程,助你充分发挥 Mintlify 的价值。" + "description": "自定进度的课程,帮助你充分利用 Mintlify。" }, { "item": "指南", @@ -411,7 +465,7 @@ }, { "group": "API 文档", - "icon": "file-json", + "icon": "file-braces", "pages": [ "zh/guides/migrating-from-mdx" ] @@ -421,6 +475,7 @@ "icon": "trophy", "pages": [ "zh/guides/accessibility", + "zh/create/changelogs", "zh/guides/content-types", "zh/guides/content-templates", "zh/guides/custom-layouts", @@ -429,7 +484,6 @@ "zh/guides/linking", "zh/guides/maintenance", "zh/guides/media", - "zh/migration", "zh/guides/navigation", "zh/guides/seo", "zh/guides/style-and-tone", diff --git a/zh/guides/knowledge-base.mdx b/zh/guides/knowledge-base.mdx index 92e69121db..31f70d2083 100644 --- a/zh/guides/knowledge-base.mdx +++ b/zh/guides/knowledge-base.mdx @@ -10,7 +10,7 @@ keywords: ["知识库", "内部文档", "私有文档", "kb", "知识管理", " Mintlify 提供搭建知识库的基础设施,让整个团队都能参与贡献。 * **AI 驱动搜索**:通过 [AI 助手](/zh/assistant/index) 使用你的知识库内容来回答问题,让用户即使不知道去哪找,也能找到答案。 -* **Slack 集成**:将 AI 助手添加到 [Slack](/zh/ai/slack-bot),这样你的团队就可以在不离开工作流程的情况下提问,并使用 [agent](/zh/agent/slack) 将对话中的信息沉淀为知识。 +* **Slack 集成**:将 [agent](/zh/agent/slack) 添加到 Slack,以便提问并从对话中捕获知识。 * **低门槛贡献**:使用 [web editor](/zh/editor) 和 [agent](/zh/agent/index),团队中的任何人都可以在不学习 Git 或 Markdown 的前提下更新内容。 * **内置认证**:通过 [SSO 或 OAuth](/zh/deploy/authentication-setup) 控制访问,并使用 [用户组](/zh/deploy/authentication-setup#control-access-with-groups) 为不同团队展示不同的内容。 diff --git a/zh/reference/concepts.mdx b/zh/reference/concepts.mdx new file mode 100644 index 0000000000..a9aa956772 --- /dev/null +++ b/zh/reference/concepts.mdx @@ -0,0 +1,109 @@ +--- +title: "核心概念" +description: "了解 Mintlify 如何连接你的组织、文档存储库、编辑工作流、部署以及 AI 功能。" +keywords: ["核心概念", "Mintlify 的工作原理", "存储库", "部署", "发布", "AI"] +--- + +Mintlify 会将 Git 存储库中的内容构建成一个文档站点。你可以在浏览器中的编辑器里工作,在本地开发环境中工作,或者在 Slack 中向 Mintlify agent 发送提示。这三种工作流都会更新同一个存储库。Mintlify 会将存储库中的内容构建为面向人类和 agent 的优化体验。 + +```mermaid +flowchart LR + Editors["Browser editors, local editors, and Mintlify agent"] --> Repo[("Documentation repository")] + Repo --> Build["Build and deployment"] + Build --> Site["Live documentation site"] + Site --> Readers["People"] + Site --> AI["AI agents"] +``` + +
+ ## 组织、部署和站点 +
+ +**组织** (organization) 是你的团队的工作空间。它包含你的成员、组织级别的设置以及一个或多个部署。 + +**部署** (deployment) 是你组织中的一个文档项目。它将一个存储库、内容目录和部署分支连接到一个已发布的站点。一个组织可以为不同的产品或文档资产拥有多个部署。 + +**在线站点** (live site) 是一个部署所发布的产物。Mintlify 默认提供一个 `.mintlify.site` 的 URL。你可以为你的站点连接一个[自定义域名](/zh/customize/custom-domain)。站点包含你的内容、导航、搜索,以及你启用的任何功能,例如 AI 助手或 API playground。 + + + 本文档有时会用 **project** 作为一个部署及其关联的存储库、配置和站点的通用名称。 + + +
+ ## 存储库是权威信息源 +
+ +你的文档存储库中包含定义站点的文件。Mintlify 会在每次构建时读取这些文件。 + +- **页面** (pages) 是 `.mdx` 文件。每个页面都包含内容和 frontmatter 元数据。 +- `docs.json` 是必需的配置文件。它控制导航、外观、集成、API 设置以及其他站点级的行为。 +- **资源** (assets) 包括页面中引用的图片、视频、字体和可下载文件。 +- **API 规范** (API specifications) 可以基于 OpenAPI、AsyncAPI 或 GraphQL schema 生成 API 参考页面和交互式 playground。 +- **可复用文件** (reusable files) 包括 snippets 和自定义 React 组件,页面可以导入使用。 + +你的存储库中可以包含未发布的文件。只有当你在 [`docs.json`](/zh/organize/navigation) 的导航中引用某个页面时,该页面才会出现在站点导航中,否则会被隐藏。[隐藏页面](/zh/organize/hidden-pages) 只能通过直接链接访问。 + +
+ ## 页面和导航是分离的 +
+ +**页面** (page) 提供某个 URL 上的内容。其 [frontmatter](/zh/organize/pages) 控制页面级的元数据和行为,包括标题、描述、图标和布局。 + +**导航** (navigation) 决定读者如何在页面之间浏览。你可以在 `docs.json` 文件中使用分组、标签、下拉菜单、产品、版本和语言等元素来配置导航。文件路径决定了页面是哪个,而它在 `docs.json` 中的位置决定了它在导航中的位置。 + +这种分离让你无需移动文件就能重新组织读者的浏览体验。它还允许你将某些工具类页面从导航中排除,同时保留通过 URL 访问的能力。 + +
+ ## 编辑和发布是不同的阶段 +
+ +你可以通过两种主要工作流来编辑同一份内容。 + +| 工作流 | 在哪里编辑 | 更改如何进入 Git | 如何预览 | +| --- | --- | --- | --- | +| Editor | 浏览器中的 Mintlify 控制台 | 编辑器会创建提交,并且可以打开拉取请求 | 在编辑器中实时预览 | +| 本地开发 | 你偏好的编辑器 | 你使用 Git 提交并推送 | `mint dev` CLI 命令 | + +在编辑器中,更改会自动**保存**,但不会立即更新你的存储库或在线站点。当你**发布**时,编辑器会将更改写入 Git。之后发生的事情取决于你当前所在的分支和分支保护设置。 + +- 在**部署分支**上,发布可以直接触发在线站点的构建。 +- 在**功能分支**上,发布可以将更改保存到该分支,或创建一个拉取请求以供审核。 +- **预览部署**会将拉取请求渲染到一个临时 URL,以便审核者在合并前检查结果。 +- 将拉取请求合并到部署分支会触发一次生产部署。 + +有关完整工作流,请参阅[分支与发布](/zh/editor/branching-and-publishing)。 + +
+ ## 构建会将源文件转换为读者体验 +
+ +当内容进入部署分支时,Mintlify 会校验项目、渲染页面并部署站点。相同的源内容支持多种查找和消费信息的方式: + +- 文档站点会为桌面和移动端用户渲染页面。 +- 搜索会为站点建立索引,让读者能够找到相关页面。 +- AI 助手可以基于文档回答问题,并注明其信息来源。 +- 页面的 Markdown 版本、`llms.txt` 和 `skill.md` 可以帮助 AI 工具理解内容。 +- 一个公开的 MCP 服务器让兼容的 AI 工具能够将文档作为结构化上下文来检索。 + +在发布前运行 [`mint validate`](/zh/cli/commands#mint-validate) 和 [`mint broken-links`](/zh/cli/commands#mint-broken-links),可以在本地捕获常见问题。 + +
+ ## Mintlify 的 AI 功能各有不同的角色 +
+ +Mintlify 为阅读、写作、自动化以及外部工具访问分别提供了不同的 AI 功能。 + +| 功能 | 使用者 | 用途 | 是否更改内容 | +| --- | --- | --- | --- | +| [Assistant](/zh/assistant) | 文档读者 | 基于你的内容回答问题 | 否 | +| [Agent](/zh/agent) | 文档维护者 | 研究并提出内容或配置更新建议 | 是 | +| [Automations](/zh/automations/index) | 文档维护者 | 按计划、存储库更新或集成事件运行 agent | 是 | +| [Search MCP server](/zh/ai/model-context-protocol) | Agents | 从单个已发布的文档站点检索上下文 | 否 | +| [Admin MCP server](/zh/ai/mintlify-mcp) | Agents | 通过经过认证的工具读取和更新部署 | 是 | +| [Mintlify Index](/zh/search-index) | Agents | 检索所有公开的 Mintlify 站点和网络上最新的技术上下文 | 否 | + +
+ ## 了解术语 +
+ +请参阅[术语表](/zh/reference/glossary),其中包含本文档中使用的 Mintlify、Git、发布、导航、API 和 AI 相关术语的定义。 diff --git a/zh/reference/glossary.mdx b/zh/reference/glossary.mdx new file mode 100644 index 0000000000..dd0ebee102 --- /dev/null +++ b/zh/reference/glossary.mdx @@ -0,0 +1,369 @@ +--- +title: "术语表" +description: "查找 Mintlify 产品、内容、导航、部署、Git、API 和 AI 相关术语的定义。" +keywords: ["术语表", "术语", "定义", "词汇"] +--- + +请将本术语表作为 Mintlify 及本文档中所用术语的快速参考。若需了解各部分如何组合,请参阅 [概念](/zh/reference/concepts)。 + +
+## A +
+ +
+### Admin MCP server +
+ +一种经过身份验证的 [Model Context Protocol](#model-context-protocol-mcp) 服务器,允许授权的 AI 工具跨组织内的一个或多个部署读取和更新内容与设置。更改在分支上进行,需通过拉取请求才能合并。参阅 [Admin MCP server](/zh/ai/mintlify-mcp)。 + +
+### Agent(代理) +
+ +一种面向文档维护者的 AI 工具,可研究、撰写、验证并发布建议的更改。根据配置,代理可以打开拉取请求或将更改提交到部署分支。参阅 [Agent](/zh/agent)。 + +
+### Anchor(锚点) +
+ +一种指向内部或外部目标的持久顶级导航链接。锚点是 `docs.json` 中可用的主要导航模式之一。参阅 [Anchors](/zh/organize/navigation#anchors)。 + +
+### Assistant(助手) +
+ +一种面向文档读者的 AI 界面,可根据你的内容回答问题。它会引用相关页面,并可将用户直接导航至相关内容。助手不会编辑你的文档。参阅 [Assistant](/zh/assistant)。 + +
+### Automation(自动化) +
+ +一种已配置的代理任务,可按计划运行、在仓库更新后运行,或响应来自已连接集成的事件。参阅 [Automations](/zh/automations/index)。 + +
+## B +
+ +
+### Branch(分支) +
+ +Git 仓库中的独立工作线。使用分支可以在不影响线上站点的情况下进行更改和评审。参阅 [Git 概念](/zh/guides/git-concepts#branch)。 + +
+### Build(构建) +
+ +验证项目文件并将其转换为可部署文档站点的过程。构建可产生线上站点或预览部署。 + +
+## C +
+ +
+### Commit(提交) +
+ +Git 仓库中已保存的更改快照。通过网页编辑器发布会创建一次提交。参阅 [Git 概念](/zh/guides/git-concepts#commit)。 + +
+### Component(组件) +
+ +一种可复用的 MDX 元素,用于呈现结构化或交互式内容,例如卡片、标注、折叠面板、选项卡或代码组。参阅 [Components](/zh/components)。 + +
+### Content directory(内容目录) +
+ +仓库中包含 `docs.json` 和 Mintlify 部署所需文件的目录。它可以是仓库根目录,或已配置的子目录,例如 monorepo 中的 `docs/`。参阅 [Monorepo 设置](/zh/deploy/monorepo)。 + +
+### Context repository(上下文仓库) +
+ +代理在执行任务时可读取以获取背景信息的附加仓库。上下文仓库不会成为文档站点的一部分。 + +
+### Credits(积分) +
+ +用于衡量 Mintlify AI 功能使用量的单位。积分在整个组织内共享,由其部署和成员共同使用。参阅 [Credits](/zh/credits)。 + +
+### Custom domain(自定义域名) +
+ +你连接到 Mintlify 站点的域名、子域名或子路径,用以替代默认的 `.mintlify.site` 地址。参阅 [Custom domain](/zh/customize/custom-domain)。 + +
+## D +
+ +
+### Dashboard(仪表盘) +
+ +经过身份验证的 Mintlify 应用,你的团队可在其中编辑内容、监控部署、管理成员,以及配置项目和组织设置。 + +
+### Deployment(部署) +
+ +Mintlify 组织内的一个文档项目。部署将源内容和部署分支连接到线上站点。该术语也可指正在发布的特定构建。 + +
+### Deployment branch(部署分支) +
+ +用于构建线上站点的 Git 分支,通常是 `main`。推送到或合并到此分支的更改会触发生产部署。参阅 [Deployment branch](/zh/guides/git-concepts#deployment-branch)。 + +
+### `docs.json` +
+ +Mintlify 站点必需的配置文件。它控制导航、外观、集成、API 设置、重定向以及其他全局行为。参阅 [`docs.json`](/zh/organize/settings)。 + + + +一种顶级导航结构,通过菜单将相关小节分组。参阅 [Dropdowns](/zh/organize/navigation#dropdowns)。 + +
+## E +
+ +
+### Editor(编辑器) +
+ +Mintlify 仪表盘中基于浏览器的编辑器。它提供协作编辑、自动保存、实时预览、Git 同步和发布工作流。参阅 [Editor overview](/zh/editor)。 + +
+## F +
+ +
+### Feature branch(功能分支) +
+ +用于准备更改的任何非部署分支。功能分支可将未完成的工作与线上站点分离。 + +
+### Frontmatter +
+ +MDX 页面开头由 `---` 行包围的 YAML 元数据。Frontmatter 控制页面属性,例如标题、描述、图标和布局。参阅 [Pages](/zh/organize/pages)。 + +
+## G +
+ +
+### Group(分组) +
+ +侧边栏中带标签的页面集合或嵌套分组。分组用于在导航小节内组织相关内容。参阅 [Groups](/zh/organize/navigation#groups)。 + +
+## I +
+ +
+### Index(索引) +
+ +一种面向编码代理的搜索服务,通过 MCP 服务器或 REST API 从发布方维护的文档和网络中检索最新的技术上下文。参阅 [Index](/zh/search-index)。 + +
+### Integration(集成) +
+ +Mintlify 与其他服务之间的连接。集成可提供分析、聊天、隐私控制、SDK 示例、自动化上下文或自动化触发器。 + +
+## L +
+ +
+### Language(语言) +
+ +在导航中配置的、特定语言/区域版本的文档。语言会创建基于语言区域的路由和语言切换器。参阅 [Languages](/zh/organize/navigation#languages)。 + +
+### Live preview(实时预览) +
+ +在网页编辑器中对你未发布的编辑进行的持续更新渲染。实时预览不会公开部署。参阅 [Live preview](/zh/editor/live-preview)。 + +
+### Live site(线上站点) +
+ +由部署分支构建、可通过 Mintlify 域名或自定义域名向读者提供的生产文档站点。 + +
+### `llms.txt` +
+ +一个自动生成的文本文件,帮助 AI 工具发现文档站点中最有价值的页面。`llms-full.txt` 将所有页面的内容合并到一个文件中。参阅 [`llms.txt`](/zh/ai/llmstxt)。 + +
+## M +
+ +
+### Markdown +
+ +一种用于格式化内容的纯文本语法,包含标题、列表、链接和代码块等元素。已发布的 Mintlify 页面也可通过在 URL 后附加 `.md` 以 Markdown 形式获取。 + +
+### MDX +
+ +扩展了 JSX 的 Markdown。Mintlify 使用 `.mdx` 页面文件,因此你可以将标准 Markdown 与组件和自定义 React 元素结合使用。 + +
+### Merge(合并) +
+ +将一个分支的更改合并到另一个分支的 Git 操作。将功能分支合并到部署分支会通过新的构建发布其更改。 + +
+### Model Context Protocol (MCP) +
+ +一种开放协议,允许 AI 应用连接到工具和数据源。Mintlify 为每个已发布的站点提供一个只读的公共 MCP 服务器,并为管理部署提供一个经过身份验证的 admin MCP 服务器。 + +
+## N +
+ + + +读者用来在文档站点中浏览的层级结构。在你的 `docs.json` 文件中通过页面、分组、选项卡、下拉菜单、产品、版本、语言和锚点来配置导航。参阅 [Navigation](/zh/organize/navigation)。 + +
+## O +
+ +
+### OpenAPI +
+ +一种描述 HTTP API 的标准格式。Mintlify 可以从 OpenAPI 文档生成端点页面、请求示例和交互式 API 试验台。参阅 [OpenAPI 设置](/zh/api-playground/openapi-setup)。 + +
+### Organization(组织) +
+ +Mintlify 工作区,包含团队成员、组织级设置、共享积分以及一个或多个部署。 + +
+## P +
+ +
+### Page(页面) +
+ +在你的文档站点上渲染为一个路由的 `.mdx` 文件。页面由 frontmatter、Markdown 内容和可选组件组成。参阅 [Pages](/zh/organize/pages)。 + +
+### Preview deployment(预览部署) +
+ +从拉取请求或指定分支构建的临时、可共享的站点版本。它让评审者可以在更改进入线上站点之前进行检查。参阅 [Preview deployments](/zh/deploy/preview-deployments)。 + +
+### Product(产品) +
+ +一种顶级导航结构,用于在单个部署中为多个不同产品发布文档。每个产品都有自己的导航。参阅 [Products](/zh/organize/navigation#products)。 + +
+### Project(项目) +
+ +一个通用术语,指 Mintlify 部署及其关联的仓库、配置和站点。在仪表盘设置和 API 中,通常使用更具体的术语 **deployment**。 + +
+### Publish(发布) +
+ +将文档更改写入 Git,使其可以推进到线上站点。根据分支和评审设置,发布可能直接部署、将提交保存到分支或创建拉取请求。 + +
+### Pull request(拉取请求) +
+ +将一个 Git 分支的更改合并到另一个分支的提议。拉取请求支持在更改到达部署分支之前进行评审、讨论、自动化检查和预览部署。GitLab 将其称为 **merge request**(合并请求)。 + +
+## R +
+ +
+### Redirect(重定向) +
+ +将访问者从旧的或备用 URL 发送到新目标的规则。重定向可在内容迁移时保持链接可用。参阅 [Redirects](/zh/create/redirects)。 + +
+### Repository(仓库) +
+ +文件及其 Git 历史的集合。文档仓库是 Mintlify 站点的唯一可信来源,包含其页面、配置和资源。 + +
+### Reusable snippet(可复用片段) +
+ +存储在单独文件中并可导入到一个或多个 MDX 页面的内容。更新源片段会更新所有使用它的页面。参阅 [Reusable snippets](/zh/create/reusable-snippets)。 + +
+## S +
+ +
+### `skill.md` +
+ +一个自动生成的文件,向 AI 代理描述产品的能力和文档。用户可将其安装为代理技能,以在使用该产品时获得更好的结果。参阅 [`skill.md`](/zh/ai/skillmd)。 + +
+### Source repository(源仓库) +
+ +包含由文档描述的产品代码、API 定义或其他材料的仓库。代理可以将已连接的源仓库用作上下文,而不会将其文件发布到文档站点上。 + +
+## T +
+ +
+### Tab(选项卡) +
+ +一种顶级导航小节,用于面向同一受众的并行文档领域,例如指南与 API 参考。参阅 [Tabs](/zh/organize/navigation#tabs)。 + +
+### Theme(主题) +
+ +文档站点的基础布局和视觉体系。主题控制整体呈现,而颜色、字体、徽标和其他设置对其进行定制。参阅 [Themes](/zh/customize/themes)。 + +
+## V +
+ +
+### Version(版本) +
+ +一种导航结构,用于并行发布同一份文档的多个版本,例如 `v1` 和 `v2`。参阅 [Versions](/zh/organize/navigation#versions)。