From 191da0a4ead3f0f402b77cd9b2ebb50b54715656 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 16:35:59 +0000 Subject: [PATCH 1/8] docs: align POC onboarding page headings and verbs with house style --- poc-onboarding.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/poc-onboarding.mdx b/poc-onboarding.mdx index af110996d..1c368c053 100644 --- a/poc-onboarding.mdx +++ b/poc-onboarding.mdx @@ -245,7 +245,7 @@ See [Appearance settings](/organize/settings-appearance), [Themes](/customize/th Open the [Assistant](https://app.mintlify.com/products/assistant) page: -1. Turn on the assistant. +1. Enable the assistant. 2. Add [deflection email addresses](/assistant/configure#set-deflection-emails) for questions that need human help. 3. Add up to three [starter questions](/assistant/configure#add-sample-questions). 4. Add [search domains](/assistant/configure#search-domains) if relevant content spans multiple sites. @@ -357,7 +357,7 @@ Most POCs take two to three weeks: | Week 2 | Review content, publish a change, apply branding, test the assistant, and evaluate one AI workflow. | | Week 3 | Complete the IT and security review, then review the results with your decision maker. | -## Getting help +## Get help - Use your shared Slack channel for time-sensitive POC questions. - Email [support@mintlify.com](mailto:support@mintlify.com) for other questions. From 389f6bf5caa3a18f1e7ed0c9b4d1618d1f99681f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 17:21:16 +0000 Subject: [PATCH 2/8] docs: merge main and use active voice in table pipe-escaping note --- api/static-export/overview.mdx | 2 +- cli/commands.mdx | 4 +- create/list-table.mdx | 14 ++ deploy/gitlab-self-hosted.mdx | 4 +- es/poc-onboarding.mdx | 420 +++++++++++++++++++++++++++++++++ fr/poc-onboarding.mdx | 420 +++++++++++++++++++++++++++++++++ poc-onboarding.mdx | 22 +- zh/poc-onboarding.mdx | 420 +++++++++++++++++++++++++++++++++ 8 files changed, 1287 insertions(+), 19 deletions(-) create mode 100644 es/poc-onboarding.mdx create mode 100644 fr/poc-onboarding.mdx create mode 100644 zh/poc-onboarding.mdx diff --git a/api/static-export/overview.mdx b/api/static-export/overview.mdx index 4a9514f3e..e7a4e2beb 100644 --- a/api/static-export/overview.mdx +++ b/api/static-export/overview.mdx @@ -54,7 +54,7 @@ Which features are available depends on how you host your deployment. Air-gapped ## Authentication -Authenticate requests with your admin API key. Generate an admin API key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secrets—do not expose them in client-side code. +Authenticate requests with your admin API key. Generate an admin API key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secrets. Do not expose them in client-side code. Copy your project ID from the same page and use it as the `projectId` path parameter. diff --git a/cli/commands.mdx b/cli/commands.mdx index 404f142a0..3434afd6d 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -345,7 +345,7 @@ All subcommands accept these shared flags: ### `mint analytics stats` -Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. Human and agent traffic are reported separately. +Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. The output reports human and agent traffic separately. ```bash mint analytics stats [flags] @@ -370,7 +370,7 @@ mint analytics search [flags] ### `mint analytics feedback` -Display feedback submitted by users. By default, returns individual feedback entries. Pass `--type page` to see feedback aggregated by page path, or `--type code` to only include feedback on code snippets. +Display user feedback. By default, returns individual feedback entries. Pass `--type page` to see feedback aggregated by page path, or `--type code` to only include feedback on code snippets. ```bash mint analytics feedback [flags] diff --git a/create/list-table.mdx b/create/list-table.mdx index 9c6611757..7977eb260 100644 --- a/create/list-table.mdx +++ b/create/list-table.mdx @@ -78,6 +78,20 @@ To add a table, use three or more hyphens (`---`) to create each column's header | Joined | Whether the user joined the community | ``` +### Escape pipe characters + +To include a literal pipe character (`|`) in a table cell, prefix it with a backslash (`\|`). Escape pipe characters even when they appear inside inline code. Otherwise, Markdown treats the pipe as a column separator, which can cause parsing errors during preview or validation. + +| Value | Description | +| ------------- | --------------------------------- | +| `read\|write` | A value containing a literal pipe | + +```mdx +| Value | Description | +| ------------- | --------------------------------- | +| `read\|write` | A value containing a literal pipe | +``` + ### Column alignment Use colons in the separator row to align column content: diff --git a/deploy/gitlab-self-hosted.mdx b/deploy/gitlab-self-hosted.mdx index d7aedae5c..7ecbb3667 100644 --- a/deploy/gitlab-self-hosted.mdx +++ b/deploy/gitlab-self-hosted.mdx @@ -42,7 +42,7 @@ Unlike gitlab.com, where Mintlify ships a single OAuth application that every cu - After saving, GitLab displays the application's **Application ID** and **Secret**. Keep this page open—the secret is only shown once. + After saving, GitLab displays the application's **Application ID** and **Secret**. Keep this page open. GitLab only shows the secret once. In your Mintlify dashboard, open **Settings** \> **Git settings** and find the **Self-hosted GitLab** section under **GitLab OAuth**. @@ -91,7 +91,7 @@ If you need to change the registered application's client secret, remove the sav ### Authorization fails with `invalid_client` -GitLab rejected the token-exchange step because the client secret Mintlify sent doesn't match what's registered on the application. The most common cause is that a secret rotated on GitLab—by an explicit **Renew secret**, or silently when someone edited the application—and the value in Mintlify is stale. +GitLab rejected the token-exchange step because the client secret Mintlify sent doesn't match what's registered on the application. The most common cause is that the secret rotated on GitLab and the value in Mintlify is stale. GitLab rotates the secret when someone clicks **Renew secret**, and can rotate it silently when someone edits the application. Fix: rotate credentials following the [Rotate credentials](#rotate-credentials) steps with the current secret. diff --git a/es/poc-onboarding.mdx b/es/poc-onboarding.mdx new file mode 100644 index 000000000..6b317a5ea --- /dev/null +++ b/es/poc-onboarding.mdx @@ -0,0 +1,420 @@ +--- +title: "Onboarding de POC" +description: "Configura y evalúa una prueba de concepto de Mintlify, desde conectar tu repositorio hasta revisar los flujos de trabajo de publicación, IA y seguridad." +keywords: ["POC", "prueba de concepto", "prueba", "evaluación", "onboarding empresarial", "piloto"] +noindex: true +--- + +Usa esta guía para configurar un sitio de documentación funcional y evaluar Mintlify con tu equipo. La mayoría de las tareas se realizan en el dashboard, pero necesitarás ayuda breve de los administradores de GitHub y de TI para algunos pasos. + + + Si te quedas atascado, contacta a tu representante de Mintlify en tu canal compartido de Slack o escribe a [support@mintlify.com](mailto:support@mintlify.com). + + +
+ ## Flujo de trabajo de la POC +
+ +Completa estos pasos en orden: + +| Paso | Resultado | +|---|---| +| 1. Conecta tu repositorio | Despliega un sitio inicial. | +| 2. Invita a tu equipo | Da a los participantes el acceso que necesitan. | +| 3. Agrega contenido de muestra | Prueba páginas representativas y complejas. | +| 4. Publica un cambio | Verifica tu flujo de trabajo de redacción y revisión. | +| 5. Aplica tu marca | Alinea el sitio con tu producto. | +| 6. Prueba las funciones de IA | Evalúa las respuestas del asistente y un flujo de trabajo de IA. | +| 7. Revisa los requisitos de TI y seguridad | Confirma los requisitos de autenticación y cumplimiento. | +| 8. Revisa los resultados | Compara la POC con tus criterios de éxito. | + +Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite editar, configurar y publicar los archivos `.mdx` y la configuración `docs.json` de ese repositorio. Tu sitio en vivo muestra el resultado publicado. + +
+ ## Antes de comenzar +
+ +
+ ### Identifica a los participantes +
+ +| Rol | Responsabilidad | Tiempo necesario | +|---|---|---| +| Responsable de la documentación | Dirige la POC y completa la mayoría de los pasos. | Unas pocas horas en total | +| Administrador de GitHub | Aprueba la aplicación de GitHub de Mintlify. | 15 minutos | +| Diseñador o responsable de marca | Proporciona logotipos, colores y fuentes. | 30 minutos | +| Administrador de identidad o TI | Configura la autenticación y el DNS, si es necesario. | 1 a 2 horas | +| Responsable de la decisión | Revisa la POC frente a tus criterios de éxito. | 1 hora | + +
+ ### Reúne tu contenido y tus recursos de marca +
+ +Recopila: + +- Variantes clara y oscura del logotipo en formato SVG o PNG. +- Un favicon, preferiblemente en formato SVG. +- Los colores de tu marca como valores hexadecimales. +- Los archivos de fuentes o los nombres de tus Google Fonts. +- Un enlace a tu documentación actual o una exportación del contenido. +- Tu archivo o URL de OpenAPI, si documentas una API. +- Tus 20 a 30 páginas con más tráfico. + +
+ ### Define el éxito +
+ +Elige un objetivo de negocio y registra su línea base actual: + +- **Adquisición:** Mejorar la tasa de activación o el tiempo hasta la primera integración. +- **Desvío:** Reducir el volumen de tickets de un tema de soporte frecuente. +- **Retención:** Aumentar la adopción de una funcionalidad después del lanzamiento. + +Agrega dos o tres criterios que puedas probar durante la POC. Por ejemplo: + +- Un redactor sin experiencia en Git puede publicar un cambio sin ayuda. +- Tu página de referencia de API más compleja se renderiza correctamente. +- El asistente responde 8 de 10 preguntas de soporte frecuentes y cita las páginas correctas. +- Tu proveedor de identidad admite el inicio de sesión en el dashboard. + +Comparte el objetivo, la línea base y los criterios con tu representante de Mintlify. + +
+ ## Paso 1: Conecta tu repositorio +
+ + + Un propietario de la organización de GitHub o un administrador del repositorio debe aprobar la aplicación de GitHub de Mintlify antes de que tu sitio pueda desplegarse. + + + + + Ve a [mintlify.com/start](https://mintlify.com/start) y regístrate con tu correo electrónico de trabajo. + + + + Conecta GitHub durante la configuración inicial. Crea un repositorio o selecciona uno vacío en la organización de tu empresa. Un repositorio privado llamado `docs` es una opción habitual. + + No selecciones un repositorio que contenga código de aplicación o archivos no relacionados. + + + + Pide a tu administrador de GitHub que instale la aplicación de GitHub de Mintlify. Concede acceso al repositorio de documentación seleccionando **Only select repositories**. + + Consulta [Instalar la aplicación de GitHub](/es/deploy/github#install-the-github-app) para ver los permisos solicitados. + + + Si no puedes aprobar la aplicación, envía la solicitud de instalación. GitHub notifica a los propietarios de tu organización. + + Para continuar mientras la aprobación está pendiente, omite el proveedor de Git durante la configuración inicial. Mintlify crea un repositorio privado que puedes mover más tarde desde [Git settings](https://app.mintlify.com/settings/deployment/git-settings). Consulta [Clonar en tu propio repositorio](/es/deploy/github#clone-to-your-own-repository). + + + + + Después de que el contenido inicial se despliegue, encuentra tu URL en la página **Overview** del [dashboard](https://app.mintlify.com/). Abre la URL `https://.mintlify.site` y confirma que carga. + + + +Usa la URL `.mintlify.site` durante la POC, a menos que necesites probar la autenticación. La autenticación requiere un dominio personalizado o un subdominio `*.mintlify.app`. + +
+ ## Paso 2: Invita a tu equipo +
+ +Abre la página [Members](https://app.mintlify.com/settings/organization/members) y asigna a cada participante el rol más restringido que necesite: + +- **Admin:** Gestiona la configuración de la organización, la facturación y las integraciones. +- **Editor:** Crea y publica contenido. +- **Viewer:** Revisa el dashboard y las analíticas sin editar. + +Consulta [Roles](/es/dashboard/roles) para ver la lista completa de permisos. + +Invita al menos a un redactor que no use Git, a un ingeniero y al responsable de la decisión. Usa sus correos electrónicos de trabajo para que sus cuentas puedan conectarse a tu proveedor de identidad durante el paso 7. + +
+ ## Paso 3: Agrega contenido de muestra +
+ +
+ ### Elige páginas representativas +
+ +Comienza con tus 20 a 30 páginas con más tráfico. Incluye: + +- Tu página de referencia de API más compleja. +- Una página con una tabla grande o una lista con anidamiento profundo. +- Una página con imágenes, video o diagramas. +- Una página con componentes personalizados o widgets incrustados. +- Dos o tres guías típicas. + +Mantén la muestra por debajo de 50 páginas para poder concentrarte en la calidad de la migración. + +
+ ### Mueve el contenido +
+ + + + Pregunta a tu representante de Mintlify si la migración está incluida en tu POC. Si lo está, envía: + + - La URL o exportación de tu documentación actual. + - Tu lista de páginas de muestra. + - Tu archivo o URL de OpenAPI, si aplica. + - Tus recursos de marca. + + Consulta [Migraciones empresariales](/es/migration-services/enterprise) para ver el proceso de migración completo. + + + + Usa uno de estos métodos: + + 1. Exporta Markdown desde tu plataforma actual. Sigue la guía de migración para [Docusaurus](/es/migration/docusaurus), [ReadMe](/es/migration/readme), [GitBook](/es/migration/gitbook), [Fern](/es/migration/fern) o [Document360](/es/migration/document360). + 2. Pega un número reducido de páginas en el editor web y limpia el formato. + 3. Convierte el contenido con una herramienta de IA usando la [skill](/es/ai/skillmd) y el [servidor MCP de administración](/es/ai/mintlify-mcp) de Mintlify. + + Consulta [Migrar a Mintlify](/es/migration) para otras plataformas. + + + + Si tu contenido de origen está en Notion, Confluence, Jira o una herramienta similar, conéctalo al agente de Mintlify. Consulta [Integraciones para el agente y las automatizaciones](/es/automations/integrations). + + + +
+ ### Revisa la migración +
+ +Compara cada página de muestra con su fuente. Verifica: + +- Imágenes, tablas y ejemplos de código. +- Enlaces internos y externos. +- Componentes personalizados y contenido incrustado. +- Las etiquetas de navegación y la ubicación de las páginas. + +Confirma que un usuario nuevo puede llegar a una página útil en dos clics y que las etiquetas de navegación usan términos que los lectores probablemente buscarán. Envía los problemas de migración a tu representante de Mintlify en una sola lista con la URL de la página y el resultado esperado. + +
+ ## Paso 4: Publica un cambio +
+ +Pide a un redactor que no use Git que complete este paso. + + + + Abre el [editor web](https://app.mintlify.com/editor). Selecciona el menú desplegable **Live site**, abre la pestaña **Branches** y selecciona **New branch**. + + Una rama mantiene el borrador separado de tu sitio desplegado. + + + + Edita la página en el editor visual. Escribe `/` para insertar un componente o arrastra una imagen a la página para subirla. + + Usa el icono del ojo para previsualizar la página renderizada y el icono `` para ver su código fuente MDX. + + + + Copia la URL de vista previa de la rama y envíala a un revisor. Haz los cambios solicitados en la misma rama. + + + + Selecciona **Publish**. Publicar desde una rama abre o actualiza un pull request. Publicar desde **Live site** despliega el cambio de inmediato. + + Confirma que la confirmación (commit) aparece en la página **Overview** del dashboard y que el cambio aprobado aparece en tu sitio. + + + + + + Los cambios del editor crean confirmaciones (commits) de Git, por lo que CODEOWNERS, las revisiones obligatorias y la protección de ramas siguen aplicándose. + + + + Los redactores pueden quedarse en la vista de Markdown del editor. Los ingenieros pueden instalar la [CLI](/es/cli/install), clonar el repositorio y ejecutar [`mint dev`](/es/cli/preview) localmente. + + + +También puedes probar los [despliegues de vista previa](/es/deploy/preview-deployments) para pull requests o [agregar el agente a Slack](/es/agent/slack#connect-your-slack-workspace) para proponer cambios de documentación desde Slack. + +
+ ## Paso 5: Aplica tu marca +
+ +Actualiza la configuración de tu marca en `docs.json`: + +```json docs.json +{ + "theme": "luma", + "colors": { + "primary": "#16A34A", + "light": "#07C983", + "dark": "#15803D" + }, + "logo": { + "light": "/logo/light-logo.svg", + "dark": "/logo/dark-logo.svg" + }, + "favicon": "/favicon.svg" +} +``` + +Después: + +1. Verifica que los enlaces y botones sigan siendo legibles en modo claro y oscuro. +2. Agrega tus fuentes usando la [configuración de fuentes](/es/customize/fonts). +3. Agrega una imagen de Open Graph predeterminada y prueba un enlace compartido en Slack. + +Consulta [Ajustes de apariencia](/es/organize/settings-appearance), [Temas](/es/customize/themes) y [SEO](/es/optimize/seo) para ver otras opciones. Si no quieres editar `docs.json`, envía tus recursos a tu representante de Mintlify. + +
+ ## Paso 6: Prueba las funciones de IA +
+ +
+ ### Configura el asistente +
+ +Abre la página del [Asistente](https://app.mintlify.com/products/assistant): + +1. Activa el asistente. +2. Agrega [correos de desvío](/es/assistant/configure#set-deflection-emails) para las preguntas que necesiten ayuda humana. +3. Agrega hasta tres [preguntas iniciales](/es/assistant/configure#add-sample-questions). +4. Agrega [dominios de búsqueda](/es/assistant/configure#search-domains) si el contenido relevante abarca varios sitios. +5. Deja habilitada la [protección contra bots](/es/assistant/configure#bot-protection). + +Consulta [Personalizar el asistente](/es/assistant/customize) y [Habilidades del asistente](/es/assistant/skills) para instrucciones y tono específicos de tu producto. + +
+ ### Prueba preguntas reales +
+ +1. Recopila 20 a 30 preguntas recientes de tickets de soporte o canales de la comunidad. +2. Haz cada pregunta a través de **Ask Assistant** en tu sitio. +3. Registra si la respuesta es correcta y cita la página adecuada. +4. Usa las respuestas erróneas o faltantes para identificar páginas que actualizar o crear. + +Revisa las preguntas sin respuesta y con voto negativo en las [analíticas del asistente](/es/analytics/assistant). Si una página relevante no se cita, haz que la `description` de su frontmatter sea específica y única. + +
+ ### Prueba un flujo de trabajo de IA adicional +
+ +Elige el flujo de trabajo más relevante para tu evaluación: + + + + Agrega el [widget del asistente](/es/assistant/widget) a tu producto, sitio de marketing o portal de soporte. + + + + Usa el [servidor MCP de búsqueda](/es/ai/model-context-protocol) para que el contenido publicado esté disponible en las herramientas de IA compatibles. Usa el [servidor MCP de administración](/es/ai/mintlify-mcp) para redactar y editar documentación. + + También puedes probar el [menú contextual](/es/ai/contextual-menu), [`llms.txt`](/es/ai/llmstxt), [`skill.md`](/es/ai/skillmd) y la [exportación de páginas en Markdown](/es/ai/markdown-export). + + + + Habilita una [automatización](/es/automations), como redactar un changelog o actualizar la documentación después de un cambio en el código. Comienza con **Require review** y luego inspecciona su pull request propuesto y el historial de ejecuciones. Consulta [Administrar automatizaciones](/es/automations/manage). + + + +
+ ## Paso 7: Revisa los requisitos de TI y seguridad +
+ +Involucra a tu equipo de TI o seguridad en la POC antes de la revisión final. + + + La autenticación del sitio no funciona en la URL predeterminada `.mintlify.site` ni en un basepath personalizado como `yourcompany.com/docs`. Usa un dominio personalizado o un subdominio `*.mintlify.app`. + + +
+ ### Controla el acceso al dashboard +
+ +Evalúa los controles que tu equipo requiere: + +- [Inicio de sesión único](/es/dashboard/sso) con SAML u OIDC. +- [Aprovisionamiento de SCIM](/es/dashboard/scim). +- [Políticas de acceso a la red](/es/dashboard/network-access). +- [Registros de auditoría](/es/dashboard/audit-logs) y [seguridad de sesiones](/es/dashboard/session-security). + +
+ ### Controla el acceso a la documentación +
+ +Configura la [autenticación](/es/deploy/authentication-setup) para tus lectores: + +- **Contraseña:** Control de acceso rápido para una POC. +- **Acceso administrado por Mintlify:** Usa tu organización del dashboard como lista de usuarios. +- **OAuth 2.0:** Se conecta a tu proveedor de identidad. +- **JWT:** Admite modelos de acceso programático personalizados. + +Usa [grupos](/es/deploy/authentication-setup#control-access-with-groups) para restringir páginas específicas: + +```yaml +--- +title: "Production runbook" +groups: ["engineering"] +--- +``` + +Haz la prueba con una cuenta dentro del grupo y otra cuenta fuera de él. + + + `hidden: true` elimina una página de la navegación pero no restringe el acceso. Usa la autenticación y los grupos para el control de acceso. Consulta [Páginas ocultas](/es/organize/hidden-pages). + + +
+ ### Completa las verificaciones de infraestructura y cumplimiento +
+ +- Agrega un [dominio personalizado](/es/customize/custom-domain). Usa un subdominio de prueba durante la POC. +- Conecta tu [plataforma de analíticas](/es/integrations/analytics/overview). +- Habilita las [comprobaciones de CI](/es/deploy/ci) para enlaces y accesibilidad. +- Comparte [Contratación empresarial](/es/enterprise-contracting) con los equipos de seguridad y compras. + +
+ ## Paso 8: Revisa los resultados +
+ +Reserva una hora con tu responsable de la decisión. Comienza con el objetivo y la línea base que definiste antes de la POC y luego revisa: + +| Criterio | Evidencia | +|---|---| +| Una persona sin perfil de desarrollo puede publicar | El resultado del paso 4 y el tiempo requerido. | +| Los ingenieros conservan el control de revisión | El pull request y sus comprobaciones. | +| El contenido complejo se migra correctamente | Páginas de muestra comparadas lado a lado. | +| El asistente responde con precisión | Tus preguntas puntuadas y las páginas citadas. | +| Las brechas de contenido son identificables | Preguntas sin respuesta y con voto negativo en las [analíticas del asistente](/es/analytics/assistant). | +| Los lectores encuentran contenido útil | Datos de [tráfico](/es/analytics/traffic), [búsqueda](/es/analytics/search) e [interacción](/es/analytics/user-engagements). | +| Las actualizaciones automatizadas son útiles | El historial de ejecuciones de la automatización y el cambio propuesto. | +| Se cumplen los requisitos de seguridad | La revisión de tu equipo de TI. | + +Resuelve las preguntas pendientes con tu representante de Mintlify antes de esta reunión. + +
+ ## Cronograma sugerido +
+ +La mayoría de las POC toman dos a tres semanas: + +| Semana | Enfoque | +|---|---| +| Semana 1 | Conecta el repositorio, invita a tu equipo, define el éxito y comienza la migración del contenido. Inicia la configuración del dominio si necesitas autenticación. | +| Semana 2 | Revisa el contenido, publica un cambio, aplica tu marca, prueba el asistente y evalúa un flujo de trabajo de IA. | +| Semana 3 | Completa la revisión de TI y seguridad y luego revisa los resultados con tu responsable de la decisión. | + +
+ ## Obtener ayuda +
+ +- Usa tu canal compartido de Slack para preguntas urgentes sobre la POC. +- Escribe a [support@mintlify.com](mailto:support@mintlify.com) para otras preguntas. +- Consulta [Soporte avanzado](/es/advanced-support) para ver las opciones de soporte posteriores a la POC. + +
+ ## Después de la POC +
+ + + Revisa todo lo que debes configurar y verificar antes del lanzamiento. + diff --git a/fr/poc-onboarding.mdx b/fr/poc-onboarding.mdx new file mode 100644 index 000000000..f913d2f92 --- /dev/null +++ b/fr/poc-onboarding.mdx @@ -0,0 +1,420 @@ +--- +title: "Onboarding POC" +description: "Configurez et évaluez une preuve de concept Mintlify, de la connexion de votre dépôt à la revue des workflows de publication, d'IA et de sécurité." +keywords: ["POC", "preuve de concept", "essai", "évaluation", "onboarding entreprise", "pilote"] +noindex: true +--- + +Utilisez ce guide pour mettre en place un site de documentation fonctionnel et évaluer Mintlify avec votre équipe. La plupart des tâches se déroulent dans le tableau de bord, mais vous aurez besoin d'une aide ponctuelle des administrateurs GitHub et IT pour certaines étapes. + + + Si vous êtes bloqué, contactez votre représentant Mintlify dans votre canal Slack partagé ou écrivez à [support@mintlify.com](mailto:support@mintlify.com). + + +
+ ## Workflow du POC +
+ +Effectuez ces étapes dans l'ordre : + +| Étape | Résultat | +|---|---| +| 1. Connecter votre dépôt | Déployer un site de démarrage. | +| 2. Inviter votre équipe | Donner aux participants l'accès dont ils ont besoin. | +| 3. Ajouter du contenu d'exemple | Tester des pages représentatives et complexes. | +| 4. Publier une modification | Vérifier votre workflow de rédaction et de revue. | +| 5. Appliquer votre image de marque | Aligner le site sur votre produit. | +| 6. Tester les fonctionnalités d'IA | Évaluer les réponses de l'assistant et un workflow d'IA. | +| 7. Passer en revue les exigences IT et de sécurité | Confirmer les exigences d'authentification et de conformité. | +| 8. Passer en revue les résultats | Comparer le POC à vos critères de réussite. | + +Votre dépôt reste la source de vérité. Le tableau de bord vous permet de modifier, configurer et publier les fichiers `.mdx` et la configuration `docs.json` de ce dépôt. Votre site en ligne affiche le résultat publié. + +
+ ## Avant de commencer +
+ +
+ ### Identifier les participants +
+ +| Rôle | Responsabilité | Temps nécessaire | +|---|---|---| +| Responsable de la documentation | Pilote le POC et réalise la plupart des étapes. | Quelques heures au total | +| Administrateur GitHub | Approuve la GitHub App Mintlify. | 15 minutes | +| Designer ou responsable de la marque | Fournit les logos, les couleurs et les polices. | 30 minutes | +| Administrateur des identités ou IT | Configure l'authentification et le DNS, si nécessaire. | 1 à 2 heures | +| Décideur | Évalue le POC par rapport à vos critères de réussite. | 1 heure | + +
+ ### Rassembler votre contenu et vos éléments de marque +
+ +Rassemblez : + +- Les variantes claire et sombre de votre logo au format SVG ou PNG. +- Un favicon, de préférence au format SVG. +- Les couleurs de votre marque sous forme de valeurs hexadécimales. +- Les fichiers de polices ou les noms de vos Google Fonts. +- Un lien vers votre documentation actuelle ou un export du contenu. +- Votre fichier ou URL OpenAPI, si vous documentez une API. +- Vos 20 à 30 pages les plus consultées. + +
+ ### Définir la réussite +
+ +Choisissez un objectif métier et notez sa valeur de référence actuelle : + +- **Acquisition :** améliorer le taux d'activation ou le délai jusqu'à la première intégration. +- **Déviation :** réduire le volume de tickets pour un sujet de support courant. +- **Rétention :** augmenter l'adoption d'une fonctionnalité après son lancement. + +Ajoutez deux ou trois critères que vous pouvez tester pendant le POC. Par exemple : + +- Un rédacteur sans expérience de Git peut publier une modification sans aide. +- Votre page de référence d'API la plus complexe s'affiche correctement. +- L'assistant répond à 8 questions de support courantes sur 10 et cite les bonnes pages. +- Votre fournisseur d'identité prend en charge la connexion au tableau de bord. + +Partagez l'objectif, la valeur de référence et les critères avec votre représentant Mintlify. + +
+ ## Étape 1 : connecter votre dépôt +
+ + + Un propriétaire de l'organisation GitHub ou un administrateur du dépôt doit approuver la GitHub App Mintlify avant que votre site puisse être déployé. + + + + + Accédez à [mintlify.com/start](https://mintlify.com/start) et inscrivez-vous avec votre adresse e-mail professionnelle. + + + + Connectez GitHub pendant l'onboarding. Créez un dépôt ou sélectionnez un dépôt vide dans l'organisation de votre entreprise. Un dépôt privé nommé `docs` est un choix courant. + + Ne sélectionnez pas un dépôt qui contient du code applicatif ou des fichiers sans rapport avec la documentation. + + + + Demandez à votre administrateur GitHub d'installer la GitHub App Mintlify. Accordez l'accès au dépôt de documentation en sélectionnant **Only select repositories**. + + Consultez [Installer la GitHub App](/fr/deploy/github#install-the-github-app) pour connaître les autorisations demandées. + + + Si vous ne pouvez pas approuver l'application, soumettez la demande d'installation. GitHub notifie les propriétaires de votre organisation. + + Pour continuer en attendant l'approbation, ignorez le fournisseur Git pendant l'onboarding. Mintlify crée un dépôt privé que vous pourrez déplacer plus tard depuis les [paramètres Git](https://app.mintlify.com/settings/deployment/git-settings). Consultez [Cloner dans votre propre dépôt](/fr/deploy/github#clone-to-your-own-repository). + + + + + Une fois le contenu de démarrage déployé, trouvez votre URL sur la page **Overview** du [tableau de bord](https://app.mintlify.com/). Ouvrez l'URL `https://.mintlify.site` et confirmez qu'elle se charge. + + + +Utilisez l'URL `.mintlify.site` pendant le POC, sauf si vous devez tester l'authentification. L'authentification nécessite un domaine personnalisé ou un sous-domaine `*.mintlify.app`. + +
+ ## Étape 2 : inviter votre équipe +
+ +Ouvrez la page [Membres](https://app.mintlify.com/settings/organization/members) et attribuez à chaque participant le rôle le plus restreint dont il a besoin : + +- **Admin :** gère les paramètres de l'organisation, la facturation et les intégrations. +- **Editor :** crée et publie du contenu. +- **Viewer :** consulte le tableau de bord et les analyses sans pouvoir modifier. + +Consultez [Rôles](/fr/dashboard/roles) pour la liste complète des autorisations. + +Invitez au moins un rédacteur qui n'utilise pas Git, un ingénieur et le décideur. Utilisez leurs adresses e-mail professionnelles afin que leurs comptes puissent se connecter à votre fournisseur d'identité lors de l'étape 7. + +
+ ## Étape 3 : ajouter du contenu d'exemple +
+ +
+ ### Choisir des pages représentatives +
+ +Commencez par vos 20 à 30 pages les plus consultées. Incluez : + +- Votre page de référence d'API la plus complexe. +- Une page contenant un grand tableau ou une liste profondément imbriquée. +- Une page contenant des images, des vidéos ou des diagrammes. +- Une page contenant des composants personnalisés ou des widgets intégrés. +- Deux ou trois guides typiques. + +Limitez l'échantillon à moins de 50 pages pour pouvoir vous concentrer sur la qualité de la migration. + +
+ ### Déplacer le contenu +
+ + + + Demandez à votre représentant Mintlify si la migration est incluse dans votre POC. Si c'est le cas, envoyez : + + - L'URL ou l'export de votre documentation actuelle. + - Votre liste de pages d'exemple. + - Votre fichier ou URL OpenAPI, le cas échéant. + - Vos éléments de marque. + + Consultez [Migrations entreprise](/fr/migration-services/enterprise) pour le processus de migration complet. + + + + Utilisez l'une de ces méthodes : + + 1. Exportez du Markdown depuis votre plateforme actuelle. Suivez le guide de migration pour [Docusaurus](/fr/migration/docusaurus), [ReadMe](/fr/migration/readme), [GitBook](/fr/migration/gitbook), [Fern](/fr/migration/fern) ou [Document360](/fr/migration/document360). + 2. Collez un petit nombre de pages dans l'éditeur web et nettoyez la mise en forme. + 3. Convertissez le contenu avec un outil d'IA en utilisant la [skill](/fr/ai/skillmd) Mintlify et le [serveur MCP d'administration](/fr/ai/mintlify-mcp). + + Consultez [Migrer vers Mintlify](/fr/migration) pour les autres plateformes. + + + + Si votre contenu source se trouve dans Notion, Confluence, Jira ou un outil similaire, connectez-le à l'agent Mintlify. Consultez [Intégrations pour l'agent et les automatisations](/fr/automations/integrations). + + + +
+ ### Vérifier la migration +
+ +Comparez chaque page d'exemple avec sa source. Vérifiez : + +- Les images, les tableaux et les exemples de code. +- Les liens internes et externes. +- Les composants personnalisés et les contenus intégrés. +- Les libellés de navigation et l'emplacement des pages. + +Confirmez qu'un nouvel utilisateur peut atteindre une page utile en deux clics et que les libellés de navigation utilisent des termes que les lecteurs sont susceptibles de rechercher. Envoyez les problèmes de migration à votre représentant Mintlify dans une seule liste, avec l'URL de la page et le résultat attendu. + +
+ ## Étape 4 : publier une modification +
+ +Demandez à un rédacteur qui n'utilise pas Git de réaliser cette étape. + + + + Ouvrez l'[éditeur web](https://app.mintlify.com/editor). Sélectionnez le menu déroulant **Live site**, ouvrez l'onglet **Branches**, puis sélectionnez **New branch**. + + Une branche garde le brouillon séparé de votre site déployé. + + + + Modifiez la page dans l'éditeur visuel. Tapez `/` pour insérer un composant ou faites glisser une image sur la page pour la téléverser. + + Utilisez l'icône en forme d'œil pour prévisualiser la page rendue et l'icône `` pour afficher sa source MDX. + + + + Copiez l'URL d'aperçu de la branche et envoyez-la à un relecteur. Apportez les modifications demandées sur la même branche. + + + + Sélectionnez **Publish**. Publier depuis une branche ouvre ou met à jour une pull request. Publier depuis **Live site** déploie la modification immédiatement. + + Confirmez que le commit apparaît sur la page **Overview** du tableau de bord et que la modification approuvée apparaît sur votre site. + + + + + + Les modifications faites dans l'éditeur créent des commits Git ; CODEOWNERS, les revues obligatoires et la protection des branches continuent donc de s'appliquer. + + + + Les rédacteurs peuvent rester dans la vue Markdown de l'éditeur. Les ingénieurs peuvent installer la [CLI](/fr/cli/install), cloner le dépôt et exécuter [`mint dev`](/fr/cli/preview) en local. + + + +Vous pouvez aussi tester les [déploiements d'aperçu](/fr/deploy/preview-deployments) pour les pull requests ou [ajouter l'agent à Slack](/fr/agent/slack#connect-your-slack-workspace) pour proposer des modifications de documentation depuis Slack. + +
+ ## Étape 5 : appliquer votre image de marque +
+ +Mettez à jour les paramètres de votre marque dans `docs.json` : + +```json docs.json +{ + "theme": "luma", + "colors": { + "primary": "#16A34A", + "light": "#07C983", + "dark": "#15803D" + }, + "logo": { + "light": "/logo/light-logo.svg", + "dark": "/logo/dark-logo.svg" + }, + "favicon": "/favicon.svg" +} +``` + +Ensuite : + +1. Vérifiez que les liens et les boutons restent lisibles en mode clair et en mode sombre. +2. Ajoutez vos polices via les [paramètres de police](/fr/customize/fonts). +3. Ajoutez une image Open Graph par défaut et testez un lien partagé dans Slack. + +Consultez les [paramètres d'apparence](/fr/organize/settings-appearance), les [thèmes](/fr/customize/themes) et le [SEO](/fr/optimize/seo) pour les autres options. Si vous ne souhaitez pas modifier `docs.json`, envoyez vos éléments de marque à votre représentant Mintlify. + +
+ ## Étape 6 : tester les fonctionnalités d'IA +
+ +
+ ### Configurer l'assistant +
+ +Ouvrez la page [Assistant](https://app.mintlify.com/products/assistant) : + +1. Activez l'assistant. +2. Ajoutez des [e-mails de redirection](/fr/assistant/configure#set-deflection-emails) pour les questions nécessitant une aide humaine. +3. Ajoutez jusqu'à trois [questions de démarrage](/fr/assistant/configure#add-sample-questions). +4. Ajoutez des [domaines de recherche](/fr/assistant/configure#search-domains) si du contenu pertinent est réparti sur plusieurs sites. +5. Laissez la [protection contre les bots](/fr/assistant/configure#bot-protection) activée. + +Consultez [Personnaliser l'assistant](/fr/assistant/customize) et [Compétences de l'assistant](/fr/assistant/skills) pour des instructions spécifiques au produit et le ton des réponses. + +
+ ### Tester des questions réelles +
+ +1. Rassemblez 20 à 30 questions récentes issues des tickets de support ou des canaux communautaires. +2. Posez chaque question via **Ask Assistant** sur votre site. +3. Notez si la réponse est correcte et si elle cite la bonne page. +4. Utilisez les réponses erronées ou manquantes pour identifier les pages à mettre à jour ou à créer. + +Passez en revue les questions sans réponse et celles ayant reçu un vote négatif dans les [analyses de l'assistant](/fr/analytics/assistant). Si une page pertinente n'est pas citée, rendez sa `description` de frontmatter spécifique et unique. + +
+ ### Tester un workflow d'IA supplémentaire +
+ +Choisissez le workflow le plus pertinent pour votre évaluation : + + + + Ajoutez le [widget de l'assistant](/fr/assistant/widget) à votre produit, à votre site marketing ou à votre portail d'assistance. + + + + Utilisez le [serveur MCP de recherche](/fr/ai/model-context-protocol) pour rendre le contenu publié disponible dans les outils d'IA pris en charge. Utilisez le [serveur MCP d'administration](/fr/ai/mintlify-mcp) pour rédiger et modifier la documentation. + + Vous pouvez aussi tester le [menu contextuel](/fr/ai/contextual-menu), [`llms.txt`](/fr/ai/llmstxt), [`skill.md`](/fr/ai/skillmd) et l'[export des pages en Markdown](/fr/ai/markdown-export). + + + + Activez une [automatisation](/fr/automations), comme la rédaction d'un changelog ou la mise à jour de la documentation après une modification du code. Commencez avec **Require review**, puis examinez la pull request proposée et l'historique des exécutions. Consultez [Gérer les automatisations](/fr/automations/manage). + + + +
+ ## Étape 7 : passer en revue les exigences IT et de sécurité +
+ +Impliquez votre équipe IT ou sécurité dans le POC avant la revue finale. + + + L'authentification du site ne fonctionne pas sur l'URL `.mintlify.site` par défaut ni sur un basepath personnalisé tel que `yourcompany.com/docs`. Utilisez un domaine personnalisé ou un sous-domaine `*.mintlify.app`. + + +
+ ### Contrôler l'accès au tableau de bord +
+ +Évaluez les contrôles requis par votre équipe : + +- L'[authentification unique](/fr/dashboard/sso) avec SAML ou OIDC. +- Le [provisionnement SCIM](/fr/dashboard/scim). +- Les [politiques d'accès réseau](/fr/dashboard/network-access). +- Les [journaux d'audit](/fr/dashboard/audit-logs) et la [sécurité des sessions](/fr/dashboard/session-security). + +
+ ### Contrôler l'accès à la documentation +
+ +Configurez l'[authentification](/fr/deploy/authentication-setup) pour vos lecteurs : + +- **Mot de passe :** contrôle d'accès rapide pour un POC. +- **Accès géré par Mintlify :** utilise l'organisation de votre tableau de bord comme liste d'utilisateurs. +- **OAuth 2.0 :** se connecte à votre fournisseur d'identité. +- **JWT :** prend en charge des modèles d'accès programmatiques personnalisés. + +Utilisez les [groupes](/fr/deploy/authentication-setup#control-access-with-groups) pour restreindre certaines pages : + +```yaml +--- +title: "Production runbook" +groups: ["engineering"] +--- +``` + +Testez avec un compte appartenant au groupe et un compte en dehors du groupe. + + + `hidden: true` retire une page de la navigation mais n'en restreint pas l'accès. Utilisez l'authentification et les groupes pour le contrôle d'accès. Consultez [Pages masquées](/fr/organize/hidden-pages). + + +
+ ### Effectuer les vérifications d'infrastructure et de conformité +
+ +- Ajoutez un [domaine personnalisé](/fr/customize/custom-domain). Utilisez un sous-domaine de test pendant le POC. +- Connectez votre [plateforme d'analyse](/fr/integrations/analytics/overview). +- Activez les [vérifications CI](/fr/deploy/ci) pour les liens et l'accessibilité. +- Partagez [Contrats entreprise](/fr/enterprise-contracting) avec les équipes sécurité et achats. + +
+ ## Étape 8 : passer en revue les résultats +
+ +Réservez une heure avec votre décideur. Commencez par l'objectif et la valeur de référence définis avant le POC, puis passez en revue : + +| Critère | Preuve | +|---|---| +| Un non-développeur peut publier | Le résultat de l'étape 4 et le temps nécessaire. | +| Les ingénieurs gardent le contrôle des revues | La pull request et ses vérifications. | +| Le contenu complexe migre correctement | Les pages d'exemple comparées côte à côte. | +| L'assistant répond avec précision | Vos questions notées et les pages citées. | +| Les lacunes de contenu sont identifiables | Les questions sans réponse et avec vote négatif dans les [analyses de l'assistant](/fr/analytics/assistant). | +| Les lecteurs trouvent du contenu utile | Les données de [trafic](/fr/analytics/traffic), de [recherche](/fr/analytics/search) et d'[engagement](/fr/analytics/user-engagements). | +| Les mises à jour automatisées sont utiles | L'historique des exécutions de l'automatisation et la modification proposée. | +| Les exigences de sécurité sont satisfaites | La revue de votre équipe IT. | + +Résolvez les questions en suspens avec votre représentant Mintlify avant cette réunion. + +
+ ## Calendrier suggéré +
+ +La plupart des POC durent deux à trois semaines : + +| Semaine | Priorité | +|---|---| +| Semaine 1 | Connecter le dépôt, inviter votre équipe, définir la réussite et démarrer la migration du contenu. Commencer la configuration du domaine si vous avez besoin de l'authentification. | +| Semaine 2 | Vérifier le contenu, publier une modification, appliquer l'image de marque, tester l'assistant et évaluer un workflow d'IA. | +| Semaine 3 | Terminer la revue IT et sécurité, puis passer en revue les résultats avec votre décideur. | + +
+ ## Obtenir de l'aide +
+ +- Utilisez votre canal Slack partagé pour les questions urgentes liées au POC. +- Écrivez à [support@mintlify.com](mailto:support@mintlify.com) pour les autres questions. +- Consultez [Support avancé](/fr/advanced-support) pour les options de support après le POC. + +
+ ## Après le POC +
+ + + Passez en revue tout ce qu'il faut configurer et vérifier avant le lancement. + diff --git a/poc-onboarding.mdx b/poc-onboarding.mdx index 1c368c053..fa4cb0659 100644 --- a/poc-onboarding.mdx +++ b/poc-onboarding.mdx @@ -8,7 +8,7 @@ noindex: true Use this guide to set up a working documentation site and evaluate Mintlify with your team. Most tasks happen in the dashboard, but you need brief help from GitHub and IT administrators for some steps. - If you get stuck, contact your Mintlify representative in your shared Slack channel or email [support@mintlify.com](mailto:support@mintlify.com). + If you get stuck, contact your account executive (AE) or solutions engineer (SE), or email [support@mintlify.com](mailto:support@mintlify.com). ## POC workflow @@ -38,7 +38,6 @@ Your repository remains the source of truth. The dashboard lets you edit, config | GitHub administrator | Approves the Mintlify GitHub App. | 15 minutes | | Designer or brand owner | Provides logos, colors, and fonts. | 30 minutes | | Identity or IT administrator | Configures authentication and DNS, if required. | 1 to 2 hours | -| Decision maker | Reviews the POC against your success criteria. | 1 hour | ### Gather your content and brand assets @@ -54,10 +53,11 @@ Collect: ### Define success -Choose one business goal and record its current baseline: +Choose one of the value drivers that customers most commonly measure Mintlify against, then record its current baseline: - **Acquisition:** Improve activation rate or time to first integration. - **Deflection:** Reduce ticket volume for a common support topic. +- **Engineering time saved:** Reduce the engineering hours spent writing, reviewing, and maintaining documentation. - **Retention:** Increase adoption of a feature after launch. Add two or three criteria that you can test during the POC. For example: @@ -67,7 +67,7 @@ Add two or three criteria that you can test during the POC. For example: - The assistant answers 8 of 10 common support questions and cites the correct pages. - Your identity provider supports dashboard login. -Share the goal, baseline, and criteria with your Mintlify representative. +Share the goal, baseline, and criteria with your AE or SE. ## Step 1: Connect your repository @@ -135,7 +135,7 @@ Keep the sample under 50 pages so you can focus on migration quality. - Ask your Mintlify representative whether migration is included in your POC. If it is, send: + Ask your AE or SE whether migration is included in your POC. If it is, send: - Your current documentation URL or export. - Your list of sample pages. @@ -169,7 +169,7 @@ Compare each sample page with its source. Check: - Custom components and embeds. - Navigation labels and page placement. -Confirm that a new user can reach a useful page in two clicks and that navigation labels use terms readers are likely to search for. Send migration issues to your Mintlify representative in one list with the page URL and expected result. +Confirm that a new user can reach a useful page in two clicks and that navigation labels use terms readers are likely to search for. Send migration issues to your AE or SE in one list with the page URL and expected result. ## Step 4: Publish a change @@ -237,7 +237,7 @@ Then: 2. Add your fonts using the [font settings](/customize/fonts). 3. Add a default Open Graph image and test a shared link in Slack. -See [Appearance settings](/organize/settings-appearance), [Themes](/customize/themes), and [SEO](/optimize/seo) for other options. If you do not want to edit `docs.json`, send your assets to your Mintlify representative. +See [Appearance settings](/organize/settings-appearance), [Themes](/customize/themes), and [SEO](/optimize/seo) for other options. If you do not want to edit `docs.json`, send your assets to your AE or SE. ## Step 6: Test AI features @@ -345,7 +345,7 @@ Book one hour with your decision maker. Start with the goal and baseline you def | Automated updates are useful | The automation run history and proposed change. | | Security requirements are met | Your IT team's review. | -Resolve open questions with your Mintlify representative before this meeting. +Resolve open questions with your AE or SE before this meeting. ## Suggested timeline @@ -357,12 +357,6 @@ Most POCs take two to three weeks: | Week 2 | Review content, publish a change, apply branding, test the assistant, and evaluate one AI workflow. | | Week 3 | Complete the IT and security review, then review the results with your decision maker. | -## Get help - -- Use your shared Slack channel for time-sensitive POC questions. -- Email [support@mintlify.com](mailto:support@mintlify.com) for other questions. -- See [Advanced support](/advanced-support) for post-POC support options. - ## After the POC diff --git a/zh/poc-onboarding.mdx b/zh/poc-onboarding.mdx new file mode 100644 index 000000000..7b36e8f1a --- /dev/null +++ b/zh/poc-onboarding.mdx @@ -0,0 +1,420 @@ +--- +title: "POC 入门指南" +description: "设置并评估 Mintlify 概念验证(POC),从连接仓库到审查发布、AI 和安全工作流。" +keywords: ["POC", "概念验证", "试用", "评估", "企业入门", "试点"] +noindex: true +--- + +使用本指南搭建一个可运行的文档站点,并与你的团队一起评估 Mintlify。大多数任务在控制面板中完成,但某些步骤需要 GitHub 和 IT 管理员的简短协助。 + + + 如果遇到困难,请在共享 Slack 频道中联系你的 Mintlify 代表,或发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。 + + +
+ ## POC 工作流 +
+ +请按顺序完成以下步骤: + +| 步骤 | 成果 | +|---|---| +| 1. 连接你的仓库 | 部署一个入门站点。 | +| 2. 邀请你的团队 | 为参与者提供所需的访问权限。 | +| 3. 添加示例内容 | 测试具有代表性的复杂页面。 | +| 4. 发布一次更改 | 验证你的写作和审查工作流。 | +| 5. 应用品牌样式 | 让站点与你的产品保持一致。 | +| 6. 测试 AI 功能 | 评估助手的回答和一个 AI 工作流。 | +| 7. 审查 IT 和安全要求 | 确认身份验证和合规要求。 | +| 8. 审查结果 | 将 POC 与你的成功标准进行对比。 | + +你的仓库始终是唯一数据源。控制面板让你可以编辑、配置和发布该仓库中的 `.mdx` 文件和 `docs.json` 配置。你的线上站点展示发布后的结果。 + +
+ ## 开始之前 +
+ +
+ ### 确定参与者 +
+ +| 角色 | 职责 | 所需时间 | +|---|---|---| +| 文档负责人 | 主导 POC 并完成大部分步骤。 | 总计几个小时 | +| GitHub 管理员 | 批准 Mintlify GitHub 应用。 | 15 分钟 | +| 设计师或品牌负责人 | 提供徽标、颜色和字体。 | 30 分钟 | +| 身份或 IT 管理员 | 配置身份验证和 DNS(如需要)。 | 1 到 2 小时 | +| 决策者 | 根据你的成功标准审查 POC。 | 1 小时 | + +
+ ### 收集你的内容和品牌资产 +
+ +请收集: + +- SVG 或 PNG 格式的浅色和深色徽标版本。 +- 一个网站图标(favicon),最好是 SVG 格式。 +- 以十六进制值表示的品牌颜色。 +- 字体文件或你的 Google Fonts 字体名称。 +- 你当前文档的链接或内容导出文件。 +- 你的 OpenAPI 文件或 URL(如果你需要为 API 编写文档)。 +- 你流量最高的 20 到 30 个页面。 + +
+ ### 定义成功标准 +
+ +选择一个业务目标并记录其当前基线: + +- **获客:** 提高激活率或缩短首次集成所需时间。 +- **工单转移:** 减少某个常见支持主题的工单数量。 +- **留存:** 提高某个功能发布后的采用率。 + +添加两到三条可以在 POC 期间测试的标准。例如: + +- 一位没有 Git 经验的作者可以在无人协助的情况下发布更改。 +- 你最复杂的 API 参考页面能正确渲染。 +- 助手能正确回答 10 个常见支持问题中的 8 个,并引用正确的页面。 +- 你的身份提供商支持控制面板登录。 + +将目标、基线和标准分享给你的 Mintlify 代表。 + +
+ ## 第 1 步:连接你的仓库 +
+ + + 在你的站点部署之前,必须由 GitHub 组织所有者或仓库管理员批准 Mintlify GitHub 应用。 + + + + + 前往 [mintlify.com/start](https://mintlify.com/start),使用你的工作邮箱注册。 + + + + 在初始设置过程中连接 GitHub。在你的公司组织中创建一个仓库或选择一个空仓库。常见的做法是使用一个名为 `docs` 的私有仓库。 + + 不要选择包含应用程序代码或无关文件的仓库。 + + + + 请你的 GitHub 管理员安装 Mintlify GitHub 应用。通过选择 **Only select repositories** 授予对文档仓库的访问权限。 + + 有关所请求的权限,请参阅[安装 GitHub 应用](/zh/deploy/github#install-the-github-app)。 + + + 如果你无法批准该应用,请提交安装请求。GitHub 会通知你的组织所有者。 + + 要在等待批准期间继续操作,可以在初始设置中跳过 Git 提供商。Mintlify 会创建一个私有仓库,你之后可以在 [Git 设置](https://app.mintlify.com/settings/deployment/git-settings)中迁移它。请参阅[克隆到你自己的仓库](/zh/deploy/github#clone-to-your-own-repository)。 + + + + + 入门内容部署完成后,在[控制面板](https://app.mintlify.com/)的 **Overview** 页面找到你的 URL。打开 `https://.mintlify.site` URL 并确认它可以加载。 + + + +除非你需要测试身份验证,否则在 POC 期间请使用 `.mintlify.site` URL。身份验证需要自定义域名或 `*.mintlify.app` 子域名。 + +
+ ## 第 2 步:邀请你的团队 +
+ +打开[成员](https://app.mintlify.com/settings/organization/members)页面,为每位参与者分配其所需的最小角色: + +- **Admin:** 管理组织设置、账单和集成。 +- **Editor:** 创建和发布内容。 +- **Viewer:** 查看控制面板和分析数据,但不能编辑。 + +完整的权限列表请参阅[角色](/zh/dashboard/roles)。 + +至少邀请一位不使用 Git 的作者、一位工程师和决策者。使用他们的工作邮箱,以便在第 7 步中将他们的账号连接到你的身份提供商。 + +
+ ## 第 3 步:添加示例内容 +
+ +
+ ### 选择有代表性的页面 +
+ +从你流量最高的 20 到 30 个页面开始。请包含: + +- 你最复杂的 API 参考页面。 +- 一个包含大型表格或深层嵌套列表的页面。 +- 一个包含图片、视频或图表的页面。 +- 一个包含自定义组件或嵌入式小组件的页面。 +- 两到三篇典型的指南。 + +将示例控制在 50 页以内,以便你专注于迁移质量。 + +
+ ### 迁移内容 +
+ + + + 询问你的 Mintlify 代表迁移服务是否包含在你的 POC 中。如果包含,请发送: + + - 你当前文档的 URL 或导出文件。 + - 你的示例页面列表。 + - 你的 OpenAPI 文件或 URL(如适用)。 + - 你的品牌资产。 + + 完整的迁移流程请参阅[企业迁移](/zh/migration-services/enterprise)。 + + + + 使用以下方法之一: + + 1. 从当前平台导出 Markdown。按照 [Docusaurus](/zh/migration/docusaurus)、[ReadMe](/zh/migration/readme)、[GitBook](/zh/migration/gitbook)、[Fern](/zh/migration/fern) 或 [Document360](/zh/migration/document360) 的迁移指南操作。 + 2. 将少量页面粘贴到网页编辑器中并清理格式。 + 3. 使用 AI 工具结合 Mintlify [skill](/zh/ai/skillmd) 和[管理 MCP 服务器](/zh/ai/mintlify-mcp)转换内容。 + + 其他平台请参阅[迁移到 Mintlify](/zh/migration)。 + + + + 如果你的源内容位于 Notion、Confluence、Jira 或类似工具中,请将其连接到 Mintlify 代理。请参阅[代理和自动化的集成](/zh/automations/integrations)。 + + + +
+ ### 审查迁移结果 +
+ +将每个示例页面与其源页面进行对比。检查: + +- 图片、表格和代码示例。 +- 内部和外部链接。 +- 自定义组件和嵌入内容。 +- 导航标签和页面位置。 + +确认新用户能在两次点击内到达有用的页面,并且导航标签使用读者可能搜索的术语。将迁移问题整理成一份列表(包含页面 URL 和预期结果)发送给你的 Mintlify 代表。 + +
+ ## 第 4 步:发布一次更改 +
+ +请一位不使用 Git 的作者完成此步骤。 + + + + 打开[网页编辑器](https://app.mintlify.com/editor)。选择 **Live site** 下拉菜单,打开 **Branches** 标签页,然后选择 **New branch**。 + + 分支可以将草稿与已部署的站点分开。 + + + + 在可视化编辑器中编辑页面。输入 `/` 插入组件,或将图片拖到页面上进行上传。 + + 使用眼睛图标预览渲染后的页面,使用 `` 图标查看其 MDX 源码。 + + + + 复制分支预览 URL 并发送给审阅者。在同一分支上完成所有被要求的修改。 + + + + 选择 **Publish**。从分支发布会打开或更新一个拉取请求。从 **Live site** 发布会立即部署更改。 + + 确认提交出现在控制面板的 **Overview** 页面上,并且已批准的更改出现在你的站点上。 + + + + + + 编辑器的更改会创建 Git 提交,因此 CODEOWNERS、必需审查和分支保护会继续生效。 + + + + 作者可以继续使用编辑器的 Markdown 视图。工程师可以安装 [CLI](/zh/cli/install),克隆仓库,并在本地运行 [`mint dev`](/zh/cli/preview)。 + + + +你还可以测试拉取请求的[预览部署](/zh/deploy/preview-deployments),或[将代理添加到 Slack](/zh/agent/slack#connect-your-slack-workspace),直接在 Slack 中提出文档更改建议。 + +
+ ## 第 5 步:应用品牌样式 +
+ +在 `docs.json` 中更新你的品牌设置: + +```json docs.json +{ + "theme": "luma", + "colors": { + "primary": "#16A34A", + "light": "#07C983", + "dark": "#15803D" + }, + "logo": { + "light": "/logo/light-logo.svg", + "dark": "/logo/dark-logo.svg" + }, + "favicon": "/favicon.svg" +} +``` + +然后: + +1. 检查链接和按钮在浅色和深色模式下是否清晰可读。 +2. 使用[字体设置](/zh/customize/fonts)添加你的字体。 +3. 添加默认的 Open Graph 图片,并在 Slack 中测试分享链接的效果。 + +其他选项请参阅[外观设置](/zh/organize/settings-appearance)、[主题](/zh/customize/themes)和 [SEO](/zh/optimize/seo)。如果你不想编辑 `docs.json`,请将资产发送给你的 Mintlify 代表。 + +
+ ## 第 6 步:测试 AI 功能 +
+ +
+ ### 配置助手 +
+ +打开[助手](https://app.mintlify.com/products/assistant)页面: + +1. 启用助手。 +2. 为需要人工协助的问题添加[转接电子邮件](/zh/assistant/configure#set-deflection-emails)。 +3. 添加最多三个[起始问题](/zh/assistant/configure#add-sample-questions)。 +4. 如果相关内容分布在多个站点上,请添加[搜索域名](/zh/assistant/configure#search-domains)。 +5. 保持[机器人防护](/zh/assistant/configure#bot-protection)处于启用状态。 + +有关产品专属说明和语气,请参阅[自定义助手](/zh/assistant/customize)和[助手技能](/zh/assistant/skills)。 + +
+ ### 测试真实问题 +
+ +1. 从支持工单或社区渠道收集 20 到 30 个近期问题。 +2. 通过站点上的 **Ask Assistant** 逐个提问。 +3. 记录回答是否正确以及是否引用了正确的页面。 +4. 利用错误或缺失的回答来确定需要更新或创建的页面。 + +在[助手分析](/zh/analytics/assistant)中审查未回答和被点踩的问题。如果相关页面未被引用,请让其 frontmatter `description` 更加具体和独特。 + +
+ ### 测试一个额外的 AI 工作流 +
+ +选择与你的评估最相关的工作流: + + + + 将[助手组件](/zh/assistant/widget)添加到你的产品、营销网站或支持门户。 + + + + 使用[搜索 MCP 服务器](/zh/ai/model-context-protocol)让已发布的内容可在受支持的 AI 工具中使用。使用[管理 MCP 服务器](/zh/ai/mintlify-mcp)起草和编辑文档。 + + 你还可以测试[上下文菜单](/zh/ai/contextual-menu)、[`llms.txt`](/zh/ai/llmstxt)、[`skill.md`](/zh/ai/skillmd) 和 [Markdown 页面导出](/zh/ai/markdown-export)。 + + + + 启用一个[自动化](/zh/automations),例如起草更新日志或在代码更改后更新文档。先从 **Require review** 开始,然后检查其提出的拉取请求和运行历史。请参阅[管理自动化](/zh/automations/manage)。 + + + +
+ ## 第 7 步:审查 IT 和安全要求 +
+ +在最终审查之前,让你的 IT 或安全团队参与到 POC 中。 + + + 站点身份验证在默认的 `.mintlify.site` URL 或自定义基础路径(例如 `yourcompany.com/docs`)上不起作用。请使用自定义域名或 `*.mintlify.app` 子域名。 + + +
+ ### 控制控制面板访问权限 +
+ +评估你的团队所需的控制措施: + +- 使用 SAML 或 OIDC 的[单点登录](/zh/dashboard/sso)。 +- [SCIM 配置](/zh/dashboard/scim)。 +- [网络访问策略](/zh/dashboard/network-access)。 +- [审计日志](/zh/dashboard/audit-logs)和[会话安全](/zh/dashboard/session-security)。 + +
+ ### 控制文档访问权限 +
+ +为你的读者配置[身份验证](/zh/deploy/authentication-setup): + +- **密码:** 适用于 POC 的快速访问控制。 +- **Mintlify 托管访问:** 使用你的控制面板组织作为用户列表。 +- **OAuth 2.0:** 连接到你的身份提供商。 +- **JWT:** 支持自定义的程序化访问模型。 + +使用[群组](/zh/deploy/authentication-setup#control-access-with-groups)限制特定页面: + +```yaml +--- +title: "Production runbook" +groups: ["engineering"] +--- +``` + +分别使用一个属于该群组的账号和一个不属于该群组的账号进行测试。 + + + `hidden: true` 会将页面从导航中移除,但不会限制访问。请使用身份验证和群组进行访问控制。请参阅[隐藏页面](/zh/organize/hidden-pages)。 + + +
+ ### 完成基础设施和合规检查 +
+ +- 添加[自定义域名](/zh/customize/custom-domain)。在 POC 期间使用测试子域名。 +- 连接你的[分析平台](/zh/integrations/analytics/overview)。 +- 为链接和可访问性启用 [CI 检查](/zh/deploy/ci)。 +- 与安全和采购团队分享[企业合同](/zh/enterprise-contracting)。 + +
+ ## 第 8 步:审查结果 +
+ +与决策者预约一小时的会议。从 POC 前定义的目标和基线开始,然后审查: + +| 标准 | 证据 | +|---|---| +| 非开发人员可以发布内容 | 第 4 步的结果和所需时间。 | +| 工程师保留审查控制权 | 拉取请求及其检查。 | +| 复杂内容迁移正确 | 示例页面的并排对比。 | +| 助手回答准确 | 你评分过的问题和引用的页面。 | +| 可以识别内容缺口 | [助手分析](/zh/analytics/assistant)中未回答和被点踩的问题。 | +| 读者能找到有用的内容 | [流量](/zh/analytics/traffic)、[搜索](/zh/analytics/search)和[用户参与](/zh/analytics/user-engagements)数据。 | +| 自动更新有价值 | 自动化的运行历史和提出的更改。 | +| 满足安全要求 | 你的 IT 团队的审查结果。 | + +在此会议之前,与你的 Mintlify 代表解决所有未决问题。 + +
+ ## 建议时间表 +
+ +大多数 POC 需要两到三周: + +| 周 | 重点 | +|---|---| +| 第 1 周 | 连接仓库、邀请团队、定义成功标准并开始内容迁移。如果需要身份验证,开始域名设置。 | +| 第 2 周 | 审查内容、发布一次更改、应用品牌样式、测试助手并评估一个 AI 工作流。 | +| 第 3 周 | 完成 IT 和安全审查,然后与决策者一起审查结果。 | + +
+ ## 获取帮助 +
+ +- 对于时间紧迫的 POC 问题,请使用你的共享 Slack 频道。 +- 其他问题请发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。 +- 有关 POC 之后的支持选项,请参阅[高级支持](/zh/advanced-support)。 + +
+ ## POC 之后 +
+ + + 审查上线前需要配置和验证的所有内容。 + From 2fa336163cc2193a66ef107fa233c88c470aa054 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 17:24:10 +0000 Subject: [PATCH 3/8] docs: sync branch with main nav logo CSS addition --- customize/custom-scripts.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/customize/custom-scripts.mdx b/customize/custom-scripts.mdx index 6a4e508a2..00deccbda 100644 --- a/customize/custom-scripts.mdx +++ b/customize/custom-scripts.mdx @@ -190,7 +190,14 @@ Multiple instances of these elements can appear on a page. Use these as `value` - `breadcrumb-item`: Individual breadcrumb item. - - `nav-logo`: Logo in the navigation bar. + - `nav-logo`: Logo image in the navigation bar. To override its default size utilities, target `img.nav-logo` and use `!important`. + + ```css + img.nav-logo { + height: 3.75rem !important; + width: auto !important; + } + ``` - `navbar-link`: Link element within the navigation bar. - `nav-anchors`: Container for anchor links in the topbar. - `nav-anchor`: Individual anchor link in the topbar. From 830f771336c31d46f3e7a1d15938d409d49c4f07 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 17:25:16 +0000 Subject: [PATCH 4/8] docs: sync POC onboarding translations with main --- es/poc-onboarding.mdx | 24 ++++++++---------------- fr/poc-onboarding.mdx | 24 ++++++++---------------- zh/poc-onboarding.mdx | 24 ++++++++---------------- 3 files changed, 24 insertions(+), 48 deletions(-) diff --git a/es/poc-onboarding.mdx b/es/poc-onboarding.mdx index 6b317a5ea..a2e5ae4f5 100644 --- a/es/poc-onboarding.mdx +++ b/es/poc-onboarding.mdx @@ -8,7 +8,7 @@ noindex: true Usa esta guía para configurar un sitio de documentación funcional y evaluar Mintlify con tu equipo. La mayoría de las tareas se realizan en el dashboard, pero necesitarás ayuda breve de los administradores de GitHub y de TI para algunos pasos. - Si te quedas atascado, contacta a tu representante de Mintlify en tu canal compartido de Slack o escribe a [support@mintlify.com](mailto:support@mintlify.com). + Si te quedas atascado, contacta a tu ejecutivo de cuenta (AE, account executive) o a tu ingeniero de soluciones (SE, solutions engineer), o escribe a [support@mintlify.com](mailto:support@mintlify.com).
@@ -44,7 +44,6 @@ Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite edit | Administrador de GitHub | Aprueba la aplicación de GitHub de Mintlify. | 15 minutos | | Diseñador o responsable de marca | Proporciona logotipos, colores y fuentes. | 30 minutos | | Administrador de identidad o TI | Configura la autenticación y el DNS, si es necesario. | 1 a 2 horas | -| Responsable de la decisión | Revisa la POC frente a tus criterios de éxito. | 1 hora |
### Reúne tu contenido y tus recursos de marca @@ -64,10 +63,11 @@ Recopila: ### Define el éxito
-Elige un objetivo de negocio y registra su línea base actual: +Elige uno de los impulsores de valor con los que los clientes suelen evaluar Mintlify y registra su línea base actual: - **Adquisición:** Mejorar la tasa de activación o el tiempo hasta la primera integración. - **Desvío:** Reducir el volumen de tickets de un tema de soporte frecuente. +- **Ahorro de tiempo de ingeniería:** Reducir las horas de ingeniería dedicadas a redactar, revisar y mantener la documentación. - **Retención:** Aumentar la adopción de una funcionalidad después del lanzamiento. Agrega dos o tres criterios que puedas probar durante la POC. Por ejemplo: @@ -77,7 +77,7 @@ Agrega dos o tres criterios que puedas probar durante la POC. Por ejemplo: - El asistente responde 8 de 10 preguntas de soporte frecuentes y cita las páginas correctas. - Tu proveedor de identidad admite el inicio de sesión en el dashboard. -Comparte el objetivo, la línea base y los criterios con tu representante de Mintlify. +Comparte el objetivo, la línea base y los criterios con tu AE o SE.
## Paso 1: Conecta tu repositorio @@ -155,7 +155,7 @@ Mantén la muestra por debajo de 50 páginas para poder concentrarte en la calid - Pregunta a tu representante de Mintlify si la migración está incluida en tu POC. Si lo está, envía: + Pregunta a tu AE o SE si la migración está incluida en tu POC. Si lo está, envía: - La URL o exportación de tu documentación actual. - Tu lista de páginas de muestra. @@ -191,7 +191,7 @@ Compara cada página de muestra con su fuente. Verifica: - Componentes personalizados y contenido incrustado. - Las etiquetas de navegación y la ubicación de las páginas. -Confirma que un usuario nuevo puede llegar a una página útil en dos clics y que las etiquetas de navegación usan términos que los lectores probablemente buscarán. Envía los problemas de migración a tu representante de Mintlify en una sola lista con la URL de la página y el resultado esperado. +Confirma que un usuario nuevo puede llegar a una página útil en dos clics y que las etiquetas de navegación usan términos que los lectores probablemente buscarán. Envía los problemas de migración a tu AE o SE en una sola lista con la URL de la página y el resultado esperado.
## Paso 4: Publica un cambio @@ -263,7 +263,7 @@ Después: 2. Agrega tus fuentes usando la [configuración de fuentes](/es/customize/fonts). 3. Agrega una imagen de Open Graph predeterminada y prueba un enlace compartido en Slack. -Consulta [Ajustes de apariencia](/es/organize/settings-appearance), [Temas](/es/customize/themes) y [SEO](/es/optimize/seo) para ver otras opciones. Si no quieres editar `docs.json`, envía tus recursos a tu representante de Mintlify. +Consulta [Ajustes de apariencia](/es/organize/settings-appearance), [Temas](/es/customize/themes) y [SEO](/es/optimize/seo) para ver otras opciones. Si no quieres editar `docs.json`, envía tus recursos a tu AE o SE.
## Paso 6: Prueba las funciones de IA @@ -389,7 +389,7 @@ Reserva una hora con tu responsable de la decisión. Comienza con el objetivo y | Las actualizaciones automatizadas son útiles | El historial de ejecuciones de la automatización y el cambio propuesto. | | Se cumplen los requisitos de seguridad | La revisión de tu equipo de TI. | -Resuelve las preguntas pendientes con tu representante de Mintlify antes de esta reunión. +Resuelve las preguntas pendientes con tu AE o SE antes de esta reunión.
## Cronograma sugerido @@ -403,14 +403,6 @@ La mayoría de las POC toman dos a tres semanas: | Semana 2 | Revisa el contenido, publica un cambio, aplica tu marca, prueba el asistente y evalúa un flujo de trabajo de IA. | | Semana 3 | Completa la revisión de TI y seguridad y luego revisa los resultados con tu responsable de la decisión. | -
- ## Obtener ayuda -
- -- Usa tu canal compartido de Slack para preguntas urgentes sobre la POC. -- Escribe a [support@mintlify.com](mailto:support@mintlify.com) para otras preguntas. -- Consulta [Soporte avanzado](/es/advanced-support) para ver las opciones de soporte posteriores a la POC. -
## Después de la POC
diff --git a/fr/poc-onboarding.mdx b/fr/poc-onboarding.mdx index f913d2f92..342c1338e 100644 --- a/fr/poc-onboarding.mdx +++ b/fr/poc-onboarding.mdx @@ -8,7 +8,7 @@ noindex: true Utilisez ce guide pour mettre en place un site de documentation fonctionnel et évaluer Mintlify avec votre équipe. La plupart des tâches se déroulent dans le tableau de bord, mais vous aurez besoin d'une aide ponctuelle des administrateurs GitHub et IT pour certaines étapes. - Si vous êtes bloqué, contactez votre représentant Mintlify dans votre canal Slack partagé ou écrivez à [support@mintlify.com](mailto:support@mintlify.com). + Si vous êtes bloqué, contactez votre responsable de compte (AE, account executive) ou votre ingénieur solutions (SE, solutions engineer), ou écrivez à [support@mintlify.com](mailto:support@mintlify.com).
@@ -44,7 +44,6 @@ Votre dépôt reste la source de vérité. Le tableau de bord vous permet de mod | Administrateur GitHub | Approuve la GitHub App Mintlify. | 15 minutes | | Designer ou responsable de la marque | Fournit les logos, les couleurs et les polices. | 30 minutes | | Administrateur des identités ou IT | Configure l'authentification et le DNS, si nécessaire. | 1 à 2 heures | -| Décideur | Évalue le POC par rapport à vos critères de réussite. | 1 heure |
### Rassembler votre contenu et vos éléments de marque @@ -64,10 +63,11 @@ Rassemblez : ### Définir la réussite
-Choisissez un objectif métier et notez sa valeur de référence actuelle : +Choisissez l'un des leviers de valeur sur lesquels les clients évaluent le plus souvent Mintlify, puis notez sa valeur de référence actuelle : - **Acquisition :** améliorer le taux d'activation ou le délai jusqu'à la première intégration. - **Déviation :** réduire le volume de tickets pour un sujet de support courant. +- **Temps d'ingénierie économisé :** réduire les heures d'ingénierie consacrées à la rédaction, à la revue et à la maintenance de la documentation. - **Rétention :** augmenter l'adoption d'une fonctionnalité après son lancement. Ajoutez deux ou trois critères que vous pouvez tester pendant le POC. Par exemple : @@ -77,7 +77,7 @@ Ajoutez deux ou trois critères que vous pouvez tester pendant le POC. Par exemp - L'assistant répond à 8 questions de support courantes sur 10 et cite les bonnes pages. - Votre fournisseur d'identité prend en charge la connexion au tableau de bord. -Partagez l'objectif, la valeur de référence et les critères avec votre représentant Mintlify. +Partagez l'objectif, la valeur de référence et les critères avec votre AE ou SE.
## Étape 1 : connecter votre dépôt @@ -155,7 +155,7 @@ Limitez l'échantillon à moins de 50 pages pour pouvoir vous concentrer sur la - Demandez à votre représentant Mintlify si la migration est incluse dans votre POC. Si c'est le cas, envoyez : + Demandez à votre AE ou SE si la migration est incluse dans votre POC. Si c'est le cas, envoyez : - L'URL ou l'export de votre documentation actuelle. - Votre liste de pages d'exemple. @@ -191,7 +191,7 @@ Comparez chaque page d'exemple avec sa source. Vérifiez : - Les composants personnalisés et les contenus intégrés. - Les libellés de navigation et l'emplacement des pages. -Confirmez qu'un nouvel utilisateur peut atteindre une page utile en deux clics et que les libellés de navigation utilisent des termes que les lecteurs sont susceptibles de rechercher. Envoyez les problèmes de migration à votre représentant Mintlify dans une seule liste, avec l'URL de la page et le résultat attendu. +Confirmez qu'un nouvel utilisateur peut atteindre une page utile en deux clics et que les libellés de navigation utilisent des termes que les lecteurs sont susceptibles de rechercher. Envoyez les problèmes de migration à votre AE ou SE dans une seule liste, avec l'URL de la page et le résultat attendu.
## Étape 4 : publier une modification @@ -263,7 +263,7 @@ Ensuite : 2. Ajoutez vos polices via les [paramètres de police](/fr/customize/fonts). 3. Ajoutez une image Open Graph par défaut et testez un lien partagé dans Slack. -Consultez les [paramètres d'apparence](/fr/organize/settings-appearance), les [thèmes](/fr/customize/themes) et le [SEO](/fr/optimize/seo) pour les autres options. Si vous ne souhaitez pas modifier `docs.json`, envoyez vos éléments de marque à votre représentant Mintlify. +Consultez les [paramètres d'apparence](/fr/organize/settings-appearance), les [thèmes](/fr/customize/themes) et le [SEO](/fr/optimize/seo) pour les autres options. Si vous ne souhaitez pas modifier `docs.json`, envoyez vos éléments de marque à votre AE ou SE.
## Étape 6 : tester les fonctionnalités d'IA @@ -389,7 +389,7 @@ Réservez une heure avec votre décideur. Commencez par l'objectif et la valeur | Les mises à jour automatisées sont utiles | L'historique des exécutions de l'automatisation et la modification proposée. | | Les exigences de sécurité sont satisfaites | La revue de votre équipe IT. | -Résolvez les questions en suspens avec votre représentant Mintlify avant cette réunion. +Résolvez les questions en suspens avec votre AE ou SE avant cette réunion.
## Calendrier suggéré @@ -403,14 +403,6 @@ La plupart des POC durent deux à trois semaines : | Semaine 2 | Vérifier le contenu, publier une modification, appliquer l'image de marque, tester l'assistant et évaluer un workflow d'IA. | | Semaine 3 | Terminer la revue IT et sécurité, puis passer en revue les résultats avec votre décideur. | -
- ## Obtenir de l'aide -
- -- Utilisez votre canal Slack partagé pour les questions urgentes liées au POC. -- Écrivez à [support@mintlify.com](mailto:support@mintlify.com) pour les autres questions. -- Consultez [Support avancé](/fr/advanced-support) pour les options de support après le POC. -
## Après le POC
diff --git a/zh/poc-onboarding.mdx b/zh/poc-onboarding.mdx index 7b36e8f1a..f2d974ea0 100644 --- a/zh/poc-onboarding.mdx +++ b/zh/poc-onboarding.mdx @@ -8,7 +8,7 @@ noindex: true 使用本指南搭建一个可运行的文档站点,并与你的团队一起评估 Mintlify。大多数任务在控制面板中完成,但某些步骤需要 GitHub 和 IT 管理员的简短协助。 - 如果遇到困难,请在共享 Slack 频道中联系你的 Mintlify 代表,或发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。 + 如果遇到困难,请联系你的客户经理(AE,account executive)或解决方案工程师(SE,solutions engineer),或发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。
@@ -44,7 +44,6 @@ noindex: true | GitHub 管理员 | 批准 Mintlify GitHub 应用。 | 15 分钟 | | 设计师或品牌负责人 | 提供徽标、颜色和字体。 | 30 分钟 | | 身份或 IT 管理员 | 配置身份验证和 DNS(如需要)。 | 1 到 2 小时 | -| 决策者 | 根据你的成功标准审查 POC。 | 1 小时 |
### 收集你的内容和品牌资产 @@ -64,10 +63,11 @@ noindex: true ### 定义成功标准
-选择一个业务目标并记录其当前基线: +从客户最常用来衡量 Mintlify 的价值驱动因素中选择一个,并记录其当前基线: - **获客:** 提高激活率或缩短首次集成所需时间。 - **工单转移:** 减少某个常见支持主题的工单数量。 +- **节省工程时间:** 减少工程师在编写、审查和维护文档上花费的时间。 - **留存:** 提高某个功能发布后的采用率。 添加两到三条可以在 POC 期间测试的标准。例如: @@ -77,7 +77,7 @@ noindex: true - 助手能正确回答 10 个常见支持问题中的 8 个,并引用正确的页面。 - 你的身份提供商支持控制面板登录。 -将目标、基线和标准分享给你的 Mintlify 代表。 +将目标、基线和标准分享给你的 AE 或 SE。
## 第 1 步:连接你的仓库 @@ -155,7 +155,7 @@ noindex: true - 询问你的 Mintlify 代表迁移服务是否包含在你的 POC 中。如果包含,请发送: + 询问你的 AE 或 SE 迁移服务是否包含在你的 POC 中。如果包含,请发送: - 你当前文档的 URL 或导出文件。 - 你的示例页面列表。 @@ -191,7 +191,7 @@ noindex: true - 自定义组件和嵌入内容。 - 导航标签和页面位置。 -确认新用户能在两次点击内到达有用的页面,并且导航标签使用读者可能搜索的术语。将迁移问题整理成一份列表(包含页面 URL 和预期结果)发送给你的 Mintlify 代表。 +确认新用户能在两次点击内到达有用的页面,并且导航标签使用读者可能搜索的术语。将迁移问题整理成一份列表(包含页面 URL 和预期结果)发送给你的 AE 或 SE。
## 第 4 步:发布一次更改 @@ -263,7 +263,7 @@ noindex: true 2. 使用[字体设置](/zh/customize/fonts)添加你的字体。 3. 添加默认的 Open Graph 图片,并在 Slack 中测试分享链接的效果。 -其他选项请参阅[外观设置](/zh/organize/settings-appearance)、[主题](/zh/customize/themes)和 [SEO](/zh/optimize/seo)。如果你不想编辑 `docs.json`,请将资产发送给你的 Mintlify 代表。 +其他选项请参阅[外观设置](/zh/organize/settings-appearance)、[主题](/zh/customize/themes)和 [SEO](/zh/optimize/seo)。如果你不想编辑 `docs.json`,请将资产发送给你的 AE 或 SE。
## 第 6 步:测试 AI 功能 @@ -389,7 +389,7 @@ groups: ["engineering"] | 自动更新有价值 | 自动化的运行历史和提出的更改。 | | 满足安全要求 | 你的 IT 团队的审查结果。 | -在此会议之前,与你的 Mintlify 代表解决所有未决问题。 +在此会议之前,与你的 AE 或 SE 解决所有未决问题。
## 建议时间表 @@ -403,14 +403,6 @@ groups: ["engineering"] | 第 2 周 | 审查内容、发布一次更改、应用品牌样式、测试助手并评估一个 AI 工作流。 | | 第 3 周 | 完成 IT 和安全审查,然后与决策者一起审查结果。 | -
- ## 获取帮助 -
- -- 对于时间紧迫的 POC 问题,请使用你的共享 Slack 频道。 -- 其他问题请发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。 -- 有关 POC 之后的支持选项,请参阅[高级支持](/zh/advanced-support)。 -
## POC 之后
From 7887df50a51a6645efd149de278cddf1246b5d0e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 19:52:35 +0000 Subject: [PATCH 5/8] docs: sync with main, restore Get help heading, drop stale step reference --- agent/use-cases.mdx | 2 +- assistant/index.mdx | 2 +- changelog.mdx | 8 ++-- cli/commands.mdx | 4 ++ cli/index.mdx | 3 ++ components/update.mdx | 2 +- deploy/rollbacks.mdx | 4 +- editor/agent.mdx | 4 +- editor/comments.mdx | 14 ++++++ editor/settings.mdx | 2 +- es/cli/commands.mdx | 4 ++ es/cli/index.mdx | 6 +++ es/create/list-table.mdx | 16 +++++++ es/customize/custom-scripts.mdx | 9 +++- es/editor/agent.mdx | 4 +- es/editor/comments.mdx | 16 +++++++ es/quickstart.mdx | 4 +- es/search-index/mcp.mdx | 2 +- fr/cli/commands.mdx | 4 ++ fr/cli/index.mdx | 6 +++ fr/create/list-table.mdx | 16 +++++++ fr/customize/custom-scripts.mdx | 9 +++- fr/editor/agent.mdx | 4 +- fr/editor/comments.mdx | 16 +++++++ fr/quickstart.mdx | 4 +- fr/search-index/mcp.mdx | 2 +- migration/fern.mdx | 2 +- optimize/seo.mdx | 2 +- poc-onboarding.mdx | 68 ++++++------------------------ quickstart.mdx | 4 +- search-index/mcp.mdx | 2 +- snippets/es/setup-agent-prompt.mdx | 4 +- snippets/fr/setup-agent-prompt.mdx | 4 +- snippets/icons-optional.mdx | 8 ++-- snippets/zh/setup-agent-prompt.mdx | 4 +- zh/cli/commands.mdx | 4 ++ zh/cli/index.mdx | 6 +++ zh/create/list-table.mdx | 16 +++++++ zh/customize/custom-scripts.mdx | 9 +++- zh/editor/agent.mdx | 4 +- zh/editor/comments.mdx | 16 +++++++ zh/quickstart.mdx | 4 +- zh/search-index/mcp.mdx | 2 +- 43 files changed, 234 insertions(+), 92 deletions(-) diff --git a/agent/use-cases.mdx b/agent/use-cases.mdx index 9e5c41292..66e510f84 100644 --- a/agent/use-cases.mdx +++ b/agent/use-cases.mdx @@ -17,7 +17,7 @@ For example: `@mintlify Our quickstart page needs a new section on inviting coll Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. -For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method. +For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then check out the branch to make any additional changes using your preferred method. ## Update docs when merging feature changes diff --git a/assistant/index.mdx b/assistant/index.mdx index b2fc3db6c..a9df441a7 100644 --- a/assistant/index.mdx +++ b/assistant/index.mdx @@ -32,7 +32,7 @@ By default, the assistant does not index hidden pages. To include hidden pages i The assistant only answers questions based on information in your documentation. If it cannot find relevant information after searching, it responds that it doesn't have enough information to answer. -You can [set a deflection email](/assistant/configure#set-deflection-email) so that the assistant provides your support email to users whose questions it cannot answer. This gives users a path forward, even if the documentation doesn't address their specific question. +You can [set a deflection email](/assistant/configure#set-deflection-emails) so that the assistant provides your support email to users whose questions it cannot answer. This gives users a path forward, even if the documentation doesn't address their specific question. ## Assistant insights diff --git a/changelog.mdx b/changelog.mdx index bed561ed2..25f7d0da3 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -199,7 +199,7 @@ noindex: true ## Editor and collaboration - **Review flow:** Request review on a draft, leave feedback, and approve or request changes before publishing. Reviews now support non-deploy branches. - - **More ways to collaborate:** Start [comment threads](/editor/comments) on an entire page, mention yourself to leave a reminder, and use keybaord shortcuts Option + C or Option + S to comment on or suggest changes to selected text. + - **More ways to collaborate:** Start [comment threads](/editor/comments) on an entire page, mention yourself to leave a reminder, and use keyboard shortcuts Option + C or Option + S to comment on or suggest changes to selected text. - **Faster, more available editing:** The editor renders without waiting for the Git file tree and people without GitHub write access can use the editor. ## Automations, integrations, and Slack @@ -2143,7 +2143,7 @@ noindex: true - Automatically generate an RSS feed from changelog pages - Integrate RSS-enabled updates with Slack, email, and other tools - Learn more in our new [Changelog guide](/create/changelogs) + Learn more in our new [Changelog guide](/create/changelogs). @@ -2478,7 +2478,7 @@ noindex: true - Delete an org functionality has been added to the dashboard. - Shipped GitLab connection UI. - Fix incorrect analytics data. - - Add-on's can now be directly purchased through the dashboard. + - Add-ons can now be directly purchased through the dashboard. ## Bug Fixes @@ -2564,7 +2564,7 @@ noindex: true - Create a custom global landing page setup with custom components - Add full-screen videos or image galleries - - Embed custom iFrame demo elements to add intractability to your docs + - Embed custom iFrame demo elements to add interactivity to your docs Check out our [Custom Mode docs](organize/pages#custom). diff --git a/cli/commands.mdx b/cli/commands.mdx index 3434afd6d..29c2388e7 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -330,6 +330,10 @@ mint automations delete [flags] Query documentation analytics from the terminal. Requires authentication with `mint login`. + + Analytics require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=analytics). + + ```bash mint analytics [flags] ``` diff --git a/cli/index.mdx b/cli/index.mdx index e3923205f..5f2eeeb91 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -39,6 +39,9 @@ Run `mint score` to evaluate how well agents can navigate a documentation site. ### Format MDX files Run `mint format` to rewrite the MDX files in your project to Mintlify's canonical style. The command walks every subdirectory and reformats files in place. +### Query analytics +Run `mint analytics` to view documentation stats, search queries, feedback, and assistant conversations from the terminal. Output defaults to JSON when the CLI detects an AI or CI environment, so agents can pipe results into other tools. + ### Manage configuration Run `mint config` to set persistent defaults like your documentation subdomain. diff --git a/components/update.mdx b/components/update.mdx index 4edcdd835..f58ddfded 100644 --- a/components/update.mdx +++ b/components/update.mdx @@ -37,7 +37,7 @@ Use the `Update` component to display changelog entries, version updates, and re Use multiple `Update` components to create [changelogs](/create/changelogs). -Update components automatically generate RSS feed entries. The entries contain pure Markdown only--components, code blocks, inline code, and raw HTML elements are not included. +Update components automatically generate RSS feed entries. The entries contain pure Markdown only—components, code blocks, inline code, and raw HTML elements are not included. If your update includes components or HTML, use the `rss` prop to provide alternative text for RSS subscribers. diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx index 73c322c78..9528650f7 100644 --- a/deploy/rollbacks.mdx +++ b/deploy/rollbacks.mdx @@ -12,7 +12,7 @@ Roll back your live site to any of your last 10 successful builds. A rollback ch Use a rollback when a change reaches your live site that you must remove immediately. -Only organization admins can roll back a deployment. +Only organization admins can roll back a deployment. The **Roll back** and **Promote** buttons appear only for admins. ## Roll back to a previous build @@ -24,6 +24,8 @@ Only organization admins can roll back a deployment. On the **Live** tab, click a successful build to expand it. Use the commit message and author to help you identify the build that you want to roll back to. + + The most recent successful build does not have a **Roll back** button because your site already serves it. Click **Roll back**. Your site serves the selected build within seconds. diff --git a/editor/agent.mdx b/editor/agent.mdx index a4735a100..3ac724e3b 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -39,7 +39,9 @@ Supported file types: - **Documents**: PDF - **Code and text**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, shell scripts, and more -Maximum size: 5 MB per file. Maximum: 10 files per message. +Maximum size: 5 MB per file, except SVG files, which are limited to 256 KB. Maximum: 10 files per message. + +Mintlify strips scripts and other active content from SVG files before the agent reads them. ## Add a selection to the agent diff --git a/editor/comments.mdx b/editor/comments.mdx index aa104b931..8db8f5b98 100644 --- a/editor/comments.mdx +++ b/editor/comments.mdx @@ -57,6 +57,20 @@ Type `@` in a comment or reply to mention a teammate. People must be a member of Mentioned teammates receive an email notification. +## Ask the Mintlify agent + +Mention `@mintlify` in a comment, [suggestion](/editor/suggestions), or reply to ask the [editor agent](/editor/agent) a question about the current page. The agent runs asynchronously with the page, thread, and branch as context, then posts its answer as a new reply in the same thread. + +Use `@mintlify` mentions to ask questions like: + +- `@mintlify does this endpoint support pagination?` +- `@mintlify is this the recommended way to configure webhooks?` +- `@mintlify are there any pages that contradict this?` + +The agent runs in read-only mode when replying to comments. It can search your docs, read pages, fetch web content, and load skills, but it cannot edit content, create suggestions, or publish changes. To make changes, open the [editor agent](/editor/agent) directly. + +`@mintlify` mentions work on private pages for members who already have access. Each agent reply counts toward your editor agent usage. + ## Resolve a comment Editors and admins can resolve threads when a discussion is complete. diff --git a/editor/settings.mdx b/editor/settings.mdx index 3f785cb3b..63bda28d5 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -86,7 +86,7 @@ using its relative path. When you enable main branch autocommits, the editor commits changes shortly after you stop typing. -Use this setting when your team edits the deployment branch directly and wants updates to reach Git without a manual publish step. If you want to review changes before they publish to your sire, do not use autocommits. +Use this setting when your team edits the deployment branch directly and wants updates to reach Git without a manual publish step. If you want to review changes before they publish to your site, do not use autocommits. Edits on feature branches created from the editor autocommit regardless of this setting. Changes on a feature branch never publish unless you merge them into your deployment branch. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index fb7ffb0f2..7c9f64e79 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -368,6 +368,10 @@ mint automations delete [flags] Consulta las analíticas de la documentación desde la terminal. Requiere autenticación con `mint login`. + + Las analíticas requieren un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=analytics). + + ```bash mint analytics [flags] ``` diff --git a/es/cli/index.mdx b/es/cli/index.mdx index 4ff122249..aa840435f 100644 --- a/es/cli/index.mdx +++ b/es/cli/index.mdx @@ -51,6 +51,12 @@ Ejecuta `mint score` para evaluar qué tan bien pueden los agentes navegar por u Ejecuta `mint format` para reescribir los archivos MDX de tu proyecto siguiendo el estilo canónico de Mintlify. El comando recorre cada subdirectorio y reformatea los archivos in situ. +
+ ### Consulta las analíticas +
+ +Ejecuta `mint analytics` para consultar estadísticas, búsquedas, feedback y conversaciones del asistente desde la terminal. La salida usa JSON por defecto cuando la CLI detecta un entorno de IA o de CI, para que los agentes puedan canalizar los resultados a otras herramientas. +
### Gestiona la configuración
diff --git a/es/create/list-table.mdx b/es/create/list-table.mdx index 31e5d5c9b..5e9eddb45 100644 --- a/es/create/list-table.mdx +++ b/es/create/list-table.mdx @@ -92,6 +92,22 @@ Para añadir una tabla, usa tres o más guiones (`---`) para crear el encabezado ``` +
+ ### Escapar caracteres de barra vertical +
+ +Para incluir un carácter de barra vertical literal (`|`) en una celda de tabla, antepón una barra invertida (`\|`). Escapa los caracteres de barra vertical incluso cuando aparezcan dentro de código en línea. De lo contrario, la barra vertical se interpreta como un separador de columnas y puede causar errores de análisis durante la vista previa o la validación. + +| Valor | Descripción | +| ------------- | ----------------------------------------------- | +| `read\|write` | Un valor que contiene una barra vertical literal | + +```mdx +| Value | Description | +| ------------- | --------------------------------- | +| `read\|write` | A value containing a literal pipe | +``` +
### Alineación de columnas
diff --git a/es/customize/custom-scripts.mdx b/es/customize/custom-scripts.mdx index 4639a0ee1..3dcabe614 100644 --- a/es/customize/custom-scripts.mdx +++ b/es/customize/custom-scripts.mdx @@ -208,7 +208,14 @@ Pueden aparecer múltiples instancias de estos elementos en una página. Úsalos - `breadcrumb-item`—Elemento individual de miga de pan. - - `nav-logo`—Logo en la barra de navegación. + - `nav-logo`—Imagen del logo en la barra de navegación. Para anular sus utilidades de tamaño predeterminadas, apunta a `img.nav-logo` y usa `!important`. + + ```css + img.nav-logo { + height: 3.75rem !important; + width: auto !important; + } + ``` - `navbar-link`—Elemento de enlace dentro de la barra de navegación. - `nav-anchors`—Contenedor de enlaces de anclaje en la barra superior. - `nav-anchor`—Enlace de anclaje individual en la barra superior. diff --git a/es/editor/agent.mdx b/es/editor/agent.mdx index aa051225f..055114df8 100644 --- a/es/editor/agent.mdx +++ b/es/editor/agent.mdx @@ -49,7 +49,9 @@ Tipos de archivo admitidos: - **Documentos**: PDF - **Código y texto**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, scripts de shell y más -Tamaño máximo: 5 MB por archivo. Máximo: 10 archivos por mensaje. +Tamaño máximo: 5 MB por archivo, excepto los archivos SVG, que están limitados a 256 KB. Máximo: 10 archivos por mensaje. + +Mintlify elimina los scripts y otro contenido activo de los archivos SVG antes de que el agente los lea.
diff --git a/es/editor/comments.mdx b/es/editor/comments.mdx index a28f6b4fd..6227c572b 100644 --- a/es/editor/comments.mdx +++ b/es/editor/comments.mdx @@ -62,6 +62,22 @@ Escribe `@` en un comentario o respuesta para mencionar a un compañero. Las per Los compañeros mencionados reciben una notificación por correo electrónico. +
+ ## Preguntar al agente de Mintlify +
+ +Menciona `@mintlify` en un comentario, [sugerencia](/es/editor/suggestions) o respuesta para hacerle una pregunta al [agente del editor](/es/editor/agent) sobre la página actual. El agente se ejecuta de forma asíncrona con la página, el hilo y la branch como contexto, y luego publica su respuesta como una nueva respuesta en el mismo hilo. + +Usa las menciones `@mintlify` para hacer preguntas como: + +- `@mintlify does this endpoint support pagination?` +- `@mintlify is this the recommended way to configure webhooks?` +- `@mintlify are there any pages that contradict this?` + +El agente se ejecuta en modo de solo lectura cuando responde a comentarios. Puede buscar en tu documentación, leer páginas, obtener contenido web y cargar skills, pero no puede editar contenido, crear sugerencias ni publicar cambios. Para hacer cambios, abre el [agente del editor](/es/editor/agent) directamente. + +Las menciones `@mintlify` funcionan en páginas privadas para los miembros que ya tienen acceso. Cada respuesta del agente cuenta para tu uso del agente del editor. +
## Resolver un comentario
diff --git a/es/quickstart.mdx b/es/quickstart.mdx index 2aca780bf..fa98d5ee8 100644 --- a/es/quickstart.mdx +++ b/es/quickstart.mdx @@ -65,7 +65,9 @@ Cuando conectas tu repositorio de documentación a tu proyecto, puedes trabajar
- Ve a [mintlify.com/start](https://mintlify.com/start) y completa el proceso de configuración inicial. Durante la configuración, conectarás tu cuenta de GitHub, crearás o seleccionarás un repositorio para tu documentación e instalarás la Aplicación de GitHub para habilitar los despliegues automáticos. + Ve a [mintlify.com/start](https://mintlify.com/start) y completa el proceso de configuración inicial. Durante la configuración, asignas un nombre a tu sitio y respondes algunas preguntas sobre cómo planeas usarlo. También puedes conectar tu cuenta de GitHub e instalar la Aplicación de GitHub para habilitar los despliegues automáticos. + + En el paso final de la configuración inicial, describe la documentación que quieres crear. Puedes agregar enlaces a tu sitio existente, subir archivos o seleccionar repositorios de GitHub para usarlos como fuentes. El agente de Mintlify genera un punto de partida para tu documentación mientras observas una vista previa en vivo. Responde las preguntas que haga el agente para refinar el resultado. Para comenzar con contenido de ejemplo, selecciona **Skip, start from a blank template**. Después de la configuración inicial, tu sitio de documentación se despliega y queda accesible en tu URL `.mintlify.site`. diff --git a/es/search-index/mcp.mdx b/es/search-index/mcp.mdx index e3b819be5..c6754dbb0 100644 --- a/es/search-index/mcp.mdx +++ b/es/search-index/mcp.mdx @@ -70,7 +70,7 @@ Index aplica los siguientes límites por IP al servidor MCP público: | Ventana | Límite | | --- | ---: | | Por segundo | 10 solicitudes | -| Por día | 1.000 solicitudes | +| Por día | 5.000 solicitudes | Las solicitudes que superan cualquiera de los límites devuelven `429 Too Many Requests`. Espera antes de volver a intentarlo y usa un backoff exponencial para clientes automatizados. diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 3cb771f2e..4389a171a 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -370,6 +370,10 @@ mint automations delete [flags] Interrogez les analytics de la documentation depuis le terminal. Nécessite une authentification avec `mint login`. + + Les analytics nécessitent un [plan Pro ou Enterprise](https://mintlify.com/pricing?ref=analytics). + + ```bash mint analytics [flags] ``` diff --git a/fr/cli/index.mdx b/fr/cli/index.mdx index f222aae2a..a9103cd73 100644 --- a/fr/cli/index.mdx +++ b/fr/cli/index.mdx @@ -51,6 +51,12 @@ Exécutez `mint score` pour évaluer dans quelle mesure les agents peuvent navig Exécutez `mint format` pour réécrire les fichiers MDX de votre projet selon le style canonique de Mintlify. La commande parcourt tous les sous-répertoires et reformate les fichiers sur place. +
+ ### Interrogez les analytics +
+ +Exécutez `mint analytics` pour consulter les statistiques, les recherches, les retours et les conversations de l'assistant depuis le terminal. Par défaut, la sortie est au format JSON lorsque la CLI détecte un environnement d'IA ou de CI, afin que les agents puissent transmettre les résultats à d'autres outils. +
### Gérez la configuration
diff --git a/fr/create/list-table.mdx b/fr/create/list-table.mdx index 6aabb01af..0b99b033e 100644 --- a/fr/create/list-table.mdx +++ b/fr/create/list-table.mdx @@ -92,6 +92,22 @@ Pour ajouter un tableau, utilisez trois tirets ou plus (`---`) pour créer l’e ``` +
+ ### Échapper les caractères barre verticale +
+ +Pour inclure un caractère barre verticale littéral (`|`) dans une cellule de tableau, faites-le précéder d'une barre oblique inverse (`\|`). Échappez les caractères barre verticale même lorsqu'ils apparaissent dans du code en ligne. Sinon, la barre verticale est interprétée comme un séparateur de colonnes et peut provoquer des erreurs d'analyse lors de la prévisualisation ou de la validation. + +| Valeur | Description | +| ------------- | ------------------------------------------------------ | +| `read\|write` | Une valeur contenant une barre verticale littérale | + +```mdx +| Value | Description | +| ------------- | --------------------------------- | +| `read\|write` | A value containing a literal pipe | +``` +
### Alignement des colonnes
diff --git a/fr/customize/custom-scripts.mdx b/fr/customize/custom-scripts.mdx index aacd79a6b..a0ea1393a 100644 --- a/fr/customize/custom-scripts.mdx +++ b/fr/customize/custom-scripts.mdx @@ -208,7 +208,14 @@ Plusieurs instances de ces éléments peuvent apparaître sur une page. Utilisez - `breadcrumb-item`—Élément individuel du fil d'Ariane.
- - `nav-logo`—Logo dans la barre de navigation. + - `nav-logo`—Image du logo dans la barre de navigation. Pour remplacer ses utilitaires de taille par défaut, ciblez `img.nav-logo` et utilisez `!important`. + + ```css + img.nav-logo { + height: 3.75rem !important; + width: auto !important; + } + ``` - `navbar-link`—Élément de lien dans la barre de navigation. - `nav-anchors`—Conteneur des liens d'ancrage dans la barre supérieure. - `nav-anchor`—Lien d'ancrage individuel dans la barre supérieure. diff --git a/fr/editor/agent.mdx b/fr/editor/agent.mdx index e9b93d3c5..75bcdb1e9 100644 --- a/fr/editor/agent.mdx +++ b/fr/editor/agent.mdx @@ -49,7 +49,9 @@ Types de fichiers pris en charge : - **Documents** : PDF - **Code et texte** : `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, scripts shell, et plus encore -Taille maximale : 5 Mo par fichier. Maximum : 10 fichiers par message. +Taille maximale : 5 Mo par fichier, sauf pour les fichiers SVG, limités à 256 Ko. Maximum : 10 fichiers par message. + +Mintlify supprime les scripts et autres contenus actifs des fichiers SVG avant que l'agent ne les lise.
diff --git a/fr/editor/comments.mdx b/fr/editor/comments.mdx index fe2da9c16..fea32cf3c 100644 --- a/fr/editor/comments.mdx +++ b/fr/editor/comments.mdx @@ -62,6 +62,22 @@ Tapez `@` dans un commentaire ou une réponse pour mentionner un coéquipier. Le Les coéquipiers mentionnés reçoivent une notification par e-mail. +
+ ## Demander à l'agent Mintlify +
+ +Mentionnez `@mintlify` dans un commentaire, une [suggestion](/fr/editor/suggestions) ou une réponse pour poser une question à l'[agent de l'éditeur](/fr/editor/agent) à propos de la page actuelle. L'agent s'exécute de manière asynchrone avec la page, le fil et la branche comme contexte, puis publie sa réponse en tant que nouvelle réponse dans le même fil. + +Utilisez les mentions `@mintlify` pour poser des questions telles que : + +- `@mintlify does this endpoint support pagination?` +- `@mintlify is this the recommended way to configure webhooks?` +- `@mintlify are there any pages that contradict this?` + +L'agent s'exécute en mode lecture seule lorsqu'il répond aux commentaires. Il peut effectuer une recherche dans votre documentation, lire des pages, récupérer du contenu web et charger des skills, mais il ne peut pas modifier le contenu, créer des suggestions ni publier de changements. Pour effectuer des modifications, ouvrez directement l'[agent de l'éditeur](/fr/editor/agent). + +Les mentions `@mintlify` fonctionnent sur les pages privées pour les membres qui y ont déjà accès. Chaque réponse de l'agent est comptabilisée dans votre utilisation de l'agent de l'éditeur. +
## Résoudre un commentaire
diff --git a/fr/quickstart.mdx b/fr/quickstart.mdx index abf1d52cb..85462876a 100644 --- a/fr/quickstart.mdx +++ b/fr/quickstart.mdx @@ -65,7 +65,9 @@ Lorsque vous connectez votre référentiel de documentation à votre projet, vou
- Accédez à [mintlify.com/start](https://mintlify.com/start) et suivez le processus d'onboarding. Pendant l'onboarding, vous connectez votre compte GitHub, créez ou sélectionnez un référentiel pour votre documentation et installez la GitHub App afin d'activer les déploiements automatiques. + Accédez à [mintlify.com/start](https://mintlify.com/start) et suivez le processus d'onboarding. Pendant l'onboarding, vous nommez votre site et répondez à quelques questions sur la façon dont vous prévoyez de l'utiliser. Vous pouvez également connecter votre compte GitHub et installer la GitHub App afin d'activer les déploiements automatiques. + + À la dernière étape de l'onboarding, décrivez la documentation que vous souhaitez créer. Vous pouvez ajouter des liens vers votre site existant, téléverser des fichiers ou sélectionner des référentiels GitHub à utiliser comme sources. L'agent Mintlify génère un point de départ pour votre documentation pendant que vous suivez un aperçu en direct. Répondez aux questions posées par l'agent pour affiner le résultat. Pour commencer avec du contenu d'exemple, sélectionnez **Skip, start from a blank template**. Après l'onboarding, votre site de documentation est déployé et accessible via l'URL `.mintlify.site` de votre site. diff --git a/fr/search-index/mcp.mdx b/fr/search-index/mcp.mdx index 9740e34b4..b3b21e69a 100644 --- a/fr/search-index/mcp.mdx +++ b/fr/search-index/mcp.mdx @@ -70,7 +70,7 @@ Index applique les limites par adresse IP suivantes au serveur MCP public : | Fenêtre | Limite | | --- | ---: | | Par seconde | 10 requêtes | -| Par jour | 1 000 requêtes | +| Par jour | 5 000 requêtes | Les requêtes dépassant l’une ou l’autre limite renvoient `429 Too Many Requests`. Attendez avant de réessayer et utilisez un back-off exponentiel pour les clients automatisés. diff --git a/migration/fern.mdx b/migration/fern.mdx index 0a6931aad..0d82dd029 100644 --- a/migration/fern.mdx +++ b/migration/fern.mdx @@ -1,6 +1,6 @@ --- title: "Migrate from Fern" -description: "Migrate a Fern to Mintlify. Convert MDX content, docs.yml navigation, products, versions, assets, API references, and components." +description: "Migrate a Fern site to Mintlify. Convert MDX content, docs.yml navigation, products, versions, assets, API references, and components." keywords: ["Fern migration", "Fern to Mintlify", "docs.yml", "Fern Docs"] --- diff --git a/optimize/seo.mdx b/optimize/seo.mdx index b36308afb..0c4167e92 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -187,7 +187,7 @@ canonical: "https://docs.example.com/latest/my-page" ``` - Always verify canonical URL behavior on your deployed site. Local builds add `/src/_props` to URLs as an artifact that are not part of the canonical URL. + Always verify canonical URL behavior on your deployed site. Local builds add `/src/_props` to URLs as an artifact that is not part of the canonical URL. ## Page-specific meta tags diff --git a/poc-onboarding.mdx b/poc-onboarding.mdx index fa4cb0659..14733a9e8 100644 --- a/poc-onboarding.mdx +++ b/poc-onboarding.mdx @@ -23,8 +23,7 @@ Complete these steps in order: | 4. Publish a change | Verify your writing and review workflow. | | 5. Apply branding | Match the site to your product. | | 6. Test AI features | Evaluate assistant answers and one AI workflow. | -| 7. Review IT and security requirements | Confirm authentication and compliance requirements. | -| 8. Review results | Compare the POC against your success criteria. | +| 7. Review results | Compare the POC against your success criteria. | Your repository remains the source of truth. The dashboard lets you edit, configure, and publish the `.mdx` files and `docs.json` configuration in that repository. Your live site displays the published result. @@ -37,7 +36,7 @@ Your repository remains the source of truth. The dashboard lets you edit, config | Documentation owner | Runs the POC and completes most steps. | A few hours total | | GitHub administrator | Approves the Mintlify GitHub App. | 15 minutes | | Designer or brand owner | Provides logos, colors, and fonts. | 30 minutes | -| Identity or IT administrator | Configures authentication and DNS, if required. | 1 to 2 hours | +| Identity or IT administrator | Configures DNS for a custom domain, if you test authentication. | 1 to 2 hours | ### Gather your content and brand assets @@ -103,7 +102,7 @@ Share the goal, baseline, and criteria with your AE or SE.
-Use the `.mintlify.site` URL during the POC unless you need to test authentication. Authentication requires a custom domain or `*.mintlify.app` subdomain. +Use the `.mintlify.site` URL during the POC unless you need to test authentication. Authentication requires a [custom domain](/customize/custom-domain) or `*.mintlify.app` subdomain, and does not work on a custom basepath such as `yourcompany.com/docs`. ## Step 2: Invite your team @@ -115,7 +114,7 @@ Open the [Members](https://app.mintlify.com/settings/organization/members) page See [Roles](/dashboard/roles) for a complete permissions list. -Invite at least one writer who does not use Git, one engineer, and the decision maker. Use their work email addresses so their accounts can connect to your identity provider during step 7. +Invite at least one writer who does not use Git, one engineer, and the decision maker. Use their work email addresses so their accounts can connect to your identity provider. ## Step 3: Add sample content @@ -282,55 +281,7 @@ Choose the workflow most relevant to your evaluation: -## Step 7: Review IT and security requirements - -Bring your IT or security team into the POC before the final review. - - - Site authentication does not work on the default `.mintlify.site` URL or on a custom basepath such as `yourcompany.com/docs`. Use a custom domain or `*.mintlify.app` subdomain. - - -### Control dashboard access - -Evaluate the controls your team requires: - -- [Single sign-on](/dashboard/sso) with SAML or OIDC. -- [SCIM provisioning](/dashboard/scim). -- [Network access policies](/dashboard/network-access). -- [Audit logs](/dashboard/audit-logs) and [session security](/dashboard/session-security). - -### Control documentation access - -Configure [authentication](/deploy/authentication-setup) for your readers: - -- **Password:** Quick access control for a POC. -- **Mintlify-managed access:** Uses your dashboard organization as the user list. -- **OAuth 2.0:** Connects to your identity provider. -- **JWT:** Supports custom programmatic access models. - -Use [groups](/deploy/authentication-setup#control-access-with-groups) to restrict specific pages: - -```yaml ---- -title: "Production runbook" -groups: ["engineering"] ---- -``` - -Test with one account in the group and one account outside it. - - - `hidden: true` removes a page from navigation but does not restrict access. Use authentication and groups for access control. See [Hidden pages](/organize/hidden-pages). - - -### Complete infrastructure and compliance checks - -- Add a [custom domain](/customize/custom-domain). Use a test subdomain during the POC. -- Connect your [analytics platform](/integrations/analytics/overview). -- Enable [CI checks](/deploy/ci) for links and accessibility. -- Share [Enterprise contracting](/enterprise-contracting) with security and procurement teams. - -## Step 8: Review results +## Step 7: Review results Book one hour with your decision maker. Start with the goal and baseline you defined before the POC, then review: @@ -343,7 +294,6 @@ Book one hour with your decision maker. Start with the goal and baseline you def | Content gaps are identifiable | Unanswered and downvoted questions in [Assistant analytics](/analytics/assistant). | | Readers find useful content | [Traffic](/analytics/traffic), [search](/analytics/search), and [engagement](/analytics/user-engagements) data. | | Automated updates are useful | The automation run history and proposed change. | -| Security requirements are met | Your IT team's review. | Resolve open questions with your AE or SE before this meeting. @@ -355,7 +305,13 @@ Most POCs take two to three weeks: |---|---| | Week 1 | Connect the repository, invite your team, define success, and start the content migration. Start domain setup if you need authentication. | | Week 2 | Review content, publish a change, apply branding, test the assistant, and evaluate one AI workflow. | -| Week 3 | Complete the IT and security review, then review the results with your decision maker. | +| Week 3 | Review the results with your decision maker. | + +## Get help + +- Contact your AE or SE for time-sensitive POC questions. +- Email [support@mintlify.com](mailto:support@mintlify.com) for other questions. +- See [Advanced support](/advanced-support) for post-POC support options. ## After the POC diff --git a/quickstart.mdx b/quickstart.mdx index 8fe1e05a5..49eb0193c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -59,7 +59,9 @@ When you connect your documentation repository to your project, you can work on ## Deploy your documentation site - Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments. + Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments. + + In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**. After onboarding, your documentation site deploys and is accessible at your `.mintlify.site` URL. diff --git a/search-index/mcp.mdx b/search-index/mcp.mdx index 11f597240..115d6c44d 100644 --- a/search-index/mcp.mdx +++ b/search-index/mcp.mdx @@ -64,7 +64,7 @@ Index applies the following per-IP limits to the public MCP server: | Window | Limit | | --- | ---: | | Per second | 10 requests | -| Per day | 1,000 requests | +| Per day | 5,000 requests | Requests exceeding either limit return `429 Too Many Requests`. Wait before retrying, and use exponential backoff for automated clients. diff --git a/snippets/es/setup-agent-prompt.mdx b/snippets/es/setup-agent-prompt.mdx index 1de34e6d6..92d431770 100644 --- a/snippets/es/setup-agent-prompt.mdx +++ b/snippets/es/setup-agent-prompt.mdx @@ -1,7 +1,7 @@ {/* vale off */} -Pon mi documentación en línea en un sitio de Mintlify publicado. Habrás terminado con éxito cuando me des la URL en vivo y confirmes que carga. Dime claramente cuando algún paso necesite mi intervención—haz todo lo demás por tu cuenta. Si este prompt se pegó antes (por ejemplo, después de un reinicio), continúa desde donde te quedaste en lugar de empezar de cero. Si no tienes acceso a la terminal o a la ejecución de comandos, dime que siga los pasos manuales en [mintlify.com/start](https://mintlify.com/start) en su lugar. Todo lo siguiente requiere ejecutar comandos y necesita Node.js v 20.17.0+ (se recomiendan versiones LTS). +Pon mi documentación en línea en un sitio de Mintlify publicado. Habrás terminado con éxito cuando me des la URL en vivo y confirmes que carga. Dime claramente cuando algún paso necesite mi intervención—haz todo lo demás por tu cuenta. Si este prompt se pegó antes (por ejemplo, después de un reinicio), continúa desde donde te quedaste en lugar de empezar de cero. Si no tienes acceso a la terminal o a la ejecución de comandos, dime que siga los pasos manuales en [mintlify.com/start](https://mintlify.com/start) en su lugar. Todo lo siguiente requiere ejecutar comandos y necesita Node.js v20.17.0+ (se recomiendan versiones LTS). 1. Pídeme el contenido existente que se usará para mi sitio de Mintlify. Puede ser una carpeta local o un repositorio. Verifica la fuente antes de construir: repite exactamente qué estás leyendo y muestra el contenido de nivel superior para que yo pueda confirmar que es correcto. Si no puedes acceder a algo que mencioné (los repositorios privados devuelven 404, igual que los inexistentes), detente y pregunta. Nunca sustituyas por una fuente diferente. 2. Comprueba si `mint` está instalado con `mint --version`. Si no lo está, instálalo con `npm i -g mint` (o `pnpm add -g mint`). Si ya está instalado, ejecuta `mint update` en lugar de reinstalarlo. @@ -17,7 +17,7 @@ Pon mi documentación en línea en un sitio de Mintlify publicado. Habrás termi 10. Haz commit y push de tus cambios. Mintlify se despliega automáticamente al hacer push. 11. Requiere mi intervención: si quiero un dominio personalizado, ejecuta `mint add-domain `. Imprime los registros DNS que necesito añadir con mi proveedor de dominio. Dime cuáles son los registros DNS, ya que solo yo puedo configurarlos con mi registrador. Deja claro que este es un paso que debo completar yo. 12. Confirma que mi sitio está activo: obtén `https://.mintlify.site` (encuentra el subdominio con `mint status`) y confirma que carga. Si agregué un dominio personalizado en el paso 11, obtén también ese dominio y confirma que carga antes de dar por completado este paso—la propagación de DNS puede tardar, así que reintenta varias veces antes de tratar una petición fallida como un error. -13. Prepárate para seguir trabajando aquí: instala la [skill de Mintlify](https://mintlify.com/docs/ai/skillmd.md) con `npx skills add https://mintlify.com/docs`, y luego registra el [servidor MCP de administración](https://mintlify.com/docs//ai/model-context-protocol.md) en `https://mcp.mintlify.com` para tu herramienta específica. Por ejemplo, `claude mcp add --transport http mintlify https://mcp.mintlify.com` para Claude Code, u obtén https://mintlify.com/docs/ai/mintlify-mcp.md para ver las instrucciones para Claude, Cursor, Codex o ChatGPT. Haz este paso por tu cuenta—no me pidas que ejecute estos comandos. +13. Prepárate para seguir trabajando aquí: instala la [skill de Mintlify](https://mintlify.com/docs/ai/skillmd.md) con `npx skills add https://mintlify.com/docs`, y luego registra el [servidor MCP de administración](https://mintlify.com/docs/ai/model-context-protocol.md) en `https://mcp.mintlify.com` para tu herramienta específica. Por ejemplo, `claude mcp add --transport http mintlify https://mcp.mintlify.com` para Claude Code, u obtén https://mintlify.com/docs/ai/mintlify-mcp.md para ver las instrucciones para Claude, Cursor, Codex o ChatGPT. Haz este paso por tu cuenta—no me pidas que ejecute estos comandos. 14. Requiere mi intervención: la primera llamada a una herramienta del MCP de administración abre una ventana del navegador para el inicio de sesión con OAuth. Apruébalo allí. La mayoría de las herramientas no cargan servidores MCP recién añadidos a mitad de sesión—si las herramientas de Mintlify no aparecen, dime que te reinicie y retomaremos desde aquí. 15. Si algún comando falla de una forma que no está cubierta arriba, detente y dime el error exacto en lugar de adivinar o reintentar a ciegas. Si parece que algo va mal por el lado de Mintlify y no por lo que estás haciendo, consulta https://status.mintlify.com o remíteme a https://mintlify.com/docs/contact-support. diff --git a/snippets/fr/setup-agent-prompt.mdx b/snippets/fr/setup-agent-prompt.mdx index d5da9e75c..7aa35d831 100644 --- a/snippets/fr/setup-agent-prompt.mdx +++ b/snippets/fr/setup-agent-prompt.mdx @@ -1,7 +1,7 @@ {/* vale off */} -Mettez ma documentation en ligne sur un site Mintlify publié. Vous avez terminé avec succès lorsque vous me donnez l'URL en direct et confirmez qu'elle se charge. Dites-moi clairement chaque fois qu'une étape nécessite mon intervention—faites tout le reste vous-même. Si ce prompt a déjà été collé (par exemple, après un redémarrage), reprenez là où vous vous étiez arrêté au lieu de recommencer depuis le début. Si vous n'avez pas accès au terminal ou à l'exécution de commandes, dites-moi de suivre les étapes manuelles sur [mintlify.com/start](https://mintlify.com/start) à la place. Tout ce qui suit nécessite d'exécuter des commandes et requiert Node.js v 20.17.0+ (les versions LTS sont recommandées). +Mettez ma documentation en ligne sur un site Mintlify publié. Vous avez terminé avec succès lorsque vous me donnez l'URL en direct et confirmez qu'elle se charge. Dites-moi clairement chaque fois qu'une étape nécessite mon intervention—faites tout le reste vous-même. Si ce prompt a déjà été collé (par exemple, après un redémarrage), reprenez là où vous vous étiez arrêté au lieu de recommencer depuis le début. Si vous n'avez pas accès au terminal ou à l'exécution de commandes, dites-moi de suivre les étapes manuelles sur [mintlify.com/start](https://mintlify.com/start) à la place. Tout ce qui suit nécessite d'exécuter des commandes et requiert Node.js v20.17.0+ (les versions LTS sont recommandées). 1. Demandez-moi le contenu existant qui sera utilisé pour mon site Mintlify. Il peut s'agir d'un dossier local ou d'un référentiel. Vérifiez la source avant de construire : reproduisez exactement ce que vous lisez et listez son contenu de niveau supérieur afin que je puisse confirmer qu'il est correct. Si vous ne pouvez pas accéder à quelque chose que j'ai indiqué (les référentiels privés renvoient 404, tout comme ceux qui n'existent pas), arrêtez-vous et demandez. Ne substituez jamais une autre source. 2. Vérifiez si `mint` est installé avec `mint --version`. S'il est absent, installez-le avec `npm i -g mint` (ou `pnpm add -g mint`). S'il est déjà installé, exécutez `mint update` au lieu de le réinstaller. @@ -17,7 +17,7 @@ Mettez ma documentation en ligne sur un site Mintlify publié. Vous avez termin 10. Faites un commit et un push de vos changements. Mintlify se déploie automatiquement lors du push. 11. Nécessite mon intervention : si je veux un domaine personnalisé, exécutez `mint add-domain `. Cette commande imprime les enregistrements DNS que je dois ajouter chez mon fournisseur de domaine. Indiquez-moi les enregistrements DNS, car moi seul peux les configurer chez mon bureau d'enregistrement. Précisez clairement qu'il s'agit d'une étape que je dois effectuer. 12. Confirmez que mon site est en ligne : récupérez `https://.mintlify.site` (trouvez le sous-domaine via `mint status`) et confirmez qu'il se charge. Si j'ai ajouté un domaine personnalisé à l'étape 11, récupérez également ce domaine et confirmez qu'il se charge avant de considérer cette étape comme terminée — la propagation DNS peut prendre du temps, réessayez donc plusieurs fois avant de considérer un échec de récupération comme une erreur. -13. Préparez-vous à continuer à travailler ici : installez la [skill Mintlify](https://mintlify.com/docs/ai/skillmd.md) avec `npx skills add https://mintlify.com/docs`, puis enregistrez le [serveur MCP d'administration](https://mintlify.com/docs//ai/model-context-protocol.md) à l'adresse `https://mcp.mintlify.com` pour votre outil spécifique. Par exemple, `claude mcp add --transport http mintlify https://mcp.mintlify.com` pour Claude Code, ou récupérez https://mintlify.com/docs/ai/mintlify-mcp.md pour obtenir les instructions pour Claude, Cursor, Codex ou ChatGPT. Faites cette étape vous-même—ne me demandez pas d'exécuter ces commandes. +13. Préparez-vous à continuer à travailler ici : installez la [skill Mintlify](https://mintlify.com/docs/ai/skillmd.md) avec `npx skills add https://mintlify.com/docs`, puis enregistrez le [serveur MCP d'administration](https://mintlify.com/docs/ai/model-context-protocol.md) à l'adresse `https://mcp.mintlify.com` pour votre outil spécifique. Par exemple, `claude mcp add --transport http mintlify https://mcp.mintlify.com` pour Claude Code, ou récupérez https://mintlify.com/docs/ai/mintlify-mcp.md pour obtenir les instructions pour Claude, Cursor, Codex ou ChatGPT. Faites cette étape vous-même—ne me demandez pas d'exécuter ces commandes. 14. Nécessite mon intervention : le premier appel d'outil MCP d'administration ouvre une fenêtre du navigateur pour la connexion OAuth. Approuvez-la là. La plupart des outils ne chargent pas les serveurs MCP nouvellement ajoutés en cours de session — si les outils Mintlify n'apparaissent pas, dites-moi de vous redémarrer et nous reprendrons ici. 15. Si une commande échoue d'une manière non couverte ci-dessus, arrêtez-vous et donnez-moi l'erreur exacte au lieu de deviner ou de réessayer à l'aveugle. S'il semble que le problème vient du côté de Mintlify plutôt que de ce que vous faites, consultez https://status.mintlify.com ou renvoyez-moi vers https://mintlify.com/docs/contact-support. diff --git a/snippets/icons-optional.mdx b/snippets/icons-optional.mdx index 530840252..9bbcd9668 100644 --- a/snippets/icons-optional.mdx +++ b/snippets/icons-optional.mdx @@ -11,10 +11,10 @@ For custom SVG icons: 1. Convert your SVG using the [SVGR converter](https://react-svgr.com/playground/). - 1. Paste your SVG code into the SVG input field. - 2. Copy the complete `...` element from the JSX output field. - 3. Wrap the JSX-compatible SVG code in curly braces: `icon={ ... }`. - 4. Adjust `height` and `width` as needed. + 2. Paste your SVG code into the SVG input field. + 3. Copy the complete `...` element from the JSX output field. + 4. Wrap the JSX-compatible SVG code in curly braces: `icon={ ... }`. + 5. Adjust `height` and `width` as needed. diff --git a/snippets/zh/setup-agent-prompt.mdx b/snippets/zh/setup-agent-prompt.mdx index 55312916b..73fdaba64 100644 --- a/snippets/zh/setup-agent-prompt.mdx +++ b/snippets/zh/setup-agent-prompt.mdx @@ -1,7 +1,7 @@ {/* vale off */} -让我的文档在已发布的 Mintlify 站点上正式上线。当你把在线 URL 给我并确认它能加载时,就算成功完成任务。当某个步骤需要我参与时,请清楚地告诉我——其他所有事情请你自己完成。如果这个提示词之前已经被粘贴过(例如在重启之后),请从上次中断的地方继续,而不是从头开始。如果你没有终端或命令执行权限,请告诉我改为在 [mintlify.com/start](https://mintlify.com/start) 按照手动步骤操作。以下所有步骤都需要执行命令,并且需要 Node.js v 20.17.0+(建议使用 LTS 版本)。 +让我的文档在已发布的 Mintlify 站点上正式上线。当你把在线 URL 给我并确认它能加载时,就算成功完成任务。当某个步骤需要我参与时,请清楚地告诉我——其他所有事情请你自己完成。如果这个提示词之前已经被粘贴过(例如在重启之后),请从上次中断的地方继续,而不是从头开始。如果你没有终端或命令执行权限,请告诉我改为在 [mintlify.com/start](https://mintlify.com/start) 按照手动步骤操作。以下所有步骤都需要执行命令,并且需要 Node.js v20.17.0+(建议使用 LTS 版本)。 1. 询问我用于 Mintlify 站点的现有内容。它可以是本地文件夹或一个仓库。构建之前请先核对来源:把你正在读取的内容原样回显给我,并列出其顶层目录内容,以便我确认无误。如果你无法访问我指定的内容(私有仓库会返回 404,与不存在的仓库相同),请停下来询问我。绝对不要用其他来源替代。 2. 使用 `mint --version` 检查是否已安装 `mint`。如果没有,请用 `npm i -g mint`(或 `pnpm add -g mint`)进行安装。如果已经安装,请运行 `mint update` 而不是重新安装。 @@ -17,7 +17,7 @@ 10. 提交并推送你的更改。Mintlify 会在推送时自动部署。 11. 需要我参与:如果我想使用自定义域名,请运行 `mint add-domain <域名>`。该命令会打印出我需要在域名服务商处添加的 DNS 记录。请把 DNS 记录告诉我,因为只有我可以在域名注册商处配置这些记录。请明确告诉我这是我必须完成的步骤。 12. 确认我的站点已上线:请获取 `https://<子域名>.mintlify.site`(通过 `mint status` 查找子域名)并确认可以加载。如果我在第 11 步添加了自定义域名,也请获取该域名并确认可以加载,然后再把这一步标记为完成——DNS 传播可能会延迟,所以在把一次获取失败当作错误之前,请多重试几次。 -13. 为在这里持续工作做好准备:使用 `npx skills add https://mintlify.com/docs` 安装 [Mintlify skill](https://mintlify.com/docs/ai/skillmd.md),然后在 `https://mcp.mintlify.com` 为你使用的具体工具注册 [admin MCP 服务器](https://mintlify.com/docs//ai/model-context-protocol.md)。例如,对于 Claude Code 使用 `claude mcp add --transport http mintlify https://mcp.mintlify.com`,或者获取 https://mintlify.com/docs/ai/mintlify-mcp.md 以查看针对 Claude、Cursor、Codex 或 ChatGPT 的说明。这一步请你自己完成——不要让我来运行这些命令。 +13. 为在这里持续工作做好准备:使用 `npx skills add https://mintlify.com/docs` 安装 [Mintlify skill](https://mintlify.com/docs/ai/skillmd.md),然后在 `https://mcp.mintlify.com` 为你使用的具体工具注册 [admin MCP 服务器](https://mintlify.com/docs/ai/model-context-protocol.md)。例如,对于 Claude Code 使用 `claude mcp add --transport http mintlify https://mcp.mintlify.com`,或者获取 https://mintlify.com/docs/ai/mintlify-mcp.md 以查看针对 Claude、Cursor、Codex 或 ChatGPT 的说明。这一步请你自己完成——不要让我来运行这些命令。 14. 需要我参与:第一次调用 admin MCP 工具时会打开一个浏览器窗口进行 OAuth 登录。请在那里批准。大多数工具在会话中途不会加载新添加的 MCP 服务器——如果 Mintlify 相关工具没有出现,请告诉我重新启动你,然后我们从这里继续。 15. 如果任何命令以上文未涵盖的方式失败,请停下来告诉我确切的错误信息,而不是随便猜测或盲目重试。如果看起来问题出在 Mintlify 一侧而不是你所做的事情上,请查看 https://status.mintlify.com 或引导我前往 https://mintlify.com/docs/contact-support。 diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 5daa37d42..11bc4d14c 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -370,6 +370,10 @@ mint automations delete [flags] 从终端查询文档分析数据。需要使用 `mint login` 进行身份验证。 + + 分析功能需要 [Pro 或 Enterprise 计划](https://mintlify.com/pricing?ref=analytics)。 + + ```bash mint analytics [flags] ``` diff --git a/zh/cli/index.mdx b/zh/cli/index.mdx index fa5b7a0bc..a9cfe01e3 100644 --- a/zh/cli/index.mdx +++ b/zh/cli/index.mdx @@ -51,6 +51,12 @@ CLI 在你的本地机器上运行,在需要实时数据时连接到你的 Min 运行 `mint format` 将项目中的 MDX 文件重写为 Mintlify 的规范样式。该命令会遍历所有子目录,并就地重新格式化文件。 +
+ ### 查询分析数据 +
+ +运行 `mint analytics` 从终端查看文档统计、搜索、反馈和助手会话。当 CLI 检测到 AI 或 CI 环境时,输出默认使用 JSON,方便 agent 将结果传给其他工具。 +
### 管理配置
diff --git a/zh/create/list-table.mdx b/zh/create/list-table.mdx index e009416c5..aa712cf2c 100644 --- a/zh/create/list-table.mdx +++ b/zh/create/list-table.mdx @@ -92,6 +92,22 @@ keywords: ["有序列表", "无序列表", "Markdown 表格", "表格格式"] ``` +
+ ### 转义竖线字符 +
+ +要在表格单元格中包含字面量竖线字符(`|`),请在其前面加上反斜杠(`\|`)。即使竖线字符出现在行内代码中,也需要转义。否则,竖线会被视为列分隔符,可能在预览或验证时导致解析错误。 + +| 值 | 说明 | +| ------------- | ------------------------ | +| `read\|write` | 包含字面量竖线的值 | + +```mdx +| Value | Description | +| ------------- | --------------------------------- | +| `read\|write` | A value containing a literal pipe | +``` +
### 列对齐
diff --git a/zh/customize/custom-scripts.mdx b/zh/customize/custom-scripts.mdx index 64d0918ed..22622f4f9 100644 --- a/zh/customize/custom-scripts.mdx +++ b/zh/customize/custom-scripts.mdx @@ -208,7 +208,14 @@ Mintlify 提供两种类型的 CSS 定位钩子: - `breadcrumb-item`—单个面包屑项。 - - `nav-logo`—导航栏中的 Logo。 + - `nav-logo`—导航栏中的 logo 图片。要覆盖其默认的尺寸工具类,请选中 `img.nav-logo` 并使用 `!important`。 + + ```css + img.nav-logo { + height: 3.75rem !important; + width: auto !important; + } + ``` - `navbar-link`—导航栏内的链接元素。 - `nav-anchors`—顶栏中锚点链接的容器。 - `nav-anchor`—顶栏中的单个锚点链接。 diff --git a/zh/editor/agent.mdx b/zh/editor/agent.mdx index 28f488787..ca747caaa 100644 --- a/zh/editor/agent.mdx +++ b/zh/editor/agent.mdx @@ -43,7 +43,9 @@ keywords: ["编辑器", "AI", "助手", "代理", "聊天", "评论", "建议", - **文档**:PDF - **代码和文本**:`.js`、`.ts`、`.jsx`、`.tsx`、`.mdx`、`.md`、`.json`、`.yaml`、`.html`、`.css`、Python、Go、Rust、Ruby、Java、Swift、C、C++、SQL、shell 脚本等 -最大大小:每个文件 5 MB。最多:每条消息 10 个文件。 +最大大小:每个文件 5 MB,SVG 文件除外,其上限为 256 KB。最多:每条消息 10 个文件。 + +在代理读取 SVG 文件之前,Mintlify 会移除其中的脚本和其他活动内容。
## 将选中内容添加到代理 diff --git a/zh/editor/comments.mdx b/zh/editor/comments.mdx index c95961376..b211d19d2 100644 --- a/zh/editor/comments.mdx +++ b/zh/editor/comments.mdx @@ -62,6 +62,22 @@ keywords: ["editor", "评论", "协作", "反馈", "提及", "讨论线程"] 被提及的团队成员会收到电子邮件通知。 +
+ ## 向 Mintlify 智能体提问 +
+ +在评论、[建议](/zh/editor/suggestions)或回复中提及 `@mintlify`,即可就当前页面向[编辑器代理](/zh/editor/agent)提问。智能体会以该页面、讨论线程和分支作为上下文异步运行,然后将答复作为新的回复发布到同一线程中。 + +使用 `@mintlify` 提及来提问,例如: + +- `@mintlify does this endpoint support pagination?` +- `@mintlify is this the recommended way to configure webhooks?` +- `@mintlify are there any pages that contradict this?` + +在回复评论时,智能体以只读模式运行。它可以搜索你的文档、阅读页面、获取网页内容以及加载 skills,但无法编辑内容、创建建议或发布更改。要进行更改,请直接打开[编辑器代理](/zh/editor/agent)。 + +对于已拥有访问权限的成员,`@mintlify` 提及在私有页面上同样有效。每次智能体回复都会计入你的编辑器代理用量。 +
## 解决评论
diff --git a/zh/quickstart.mdx b/zh/quickstart.mdx index d413a8155..6b68a1039 100644 --- a/zh/quickstart.mdx +++ b/zh/quickstart.mdx @@ -65,7 +65,9 @@ Mintlify 使用“文档即代码”(docs-as-code)的方法来管理你的
- 前往 [mintlify.com/start](https://mintlify.com/start) 并完成初始设置流程。在初始设置过程中,你会连接你的 GitHub 账户,为文档创建或选择一个存储库,并安装 GitHub 应用以启用自动部署。 + 前往 [mintlify.com/start](https://mintlify.com/start) 并完成初始设置流程。在初始设置过程中,你需要为站点命名,并回答几个关于使用计划的问题。你还可以连接你的 GitHub 账户并安装 GitHub 应用以启用自动部署。 + + 在初始设置的最后一步,描述你想要构建的文档。你可以添加现有网站的链接、上传文件,或选择 GitHub 存储库作为资料来源。Mintlify 智能体会为你的文档生成一个起点,你可以通过实时预览查看进度。回答智能体提出的问题以完善生成结果。若想从占位内容开始,请选择 **Skip, start from a blank template**。 完成初始设置后,你的文档站点会完成部署,并可通过 `.mintlify.site` URL 访问。 diff --git a/zh/search-index/mcp.mdx b/zh/search-index/mcp.mdx index 5c8905d14..6c4a14f15 100644 --- a/zh/search-index/mcp.mdx +++ b/zh/search-index/mcp.mdx @@ -70,7 +70,7 @@ Index 对公开 MCP 服务器实施以下按 IP 计算的限制: | 时间窗口 | 限制 | | --- | ---: | | 每秒 | 10 个请求 | -| 每天 | 1,000 个请求 | +| 每天 | 5,000 个请求 | 超过任一限制的请求会返回 `429 Too Many Requests`。请等待后重试,自动化客户端应使用指数退避。 From 8804c58d3eeafd958060ef8868e141d9dc26c431 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 19:58:00 +0000 Subject: [PATCH 6/8] docs: sync branch with main llms index and translation updates --- ai/llmstxt.mdx | 25 ++++++++++--- deploy/reverse-proxy.mdx | 17 +++++++++ es/poc-onboarding.mdx | 78 ++++++++-------------------------------- fr/poc-onboarding.mdx | 78 ++++++++-------------------------------- zh/poc-onboarding.mdx | 78 ++++++++-------------------------------- 5 files changed, 80 insertions(+), 196 deletions(-) diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index 58fb21916..c362042e1 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -55,11 +55,28 @@ Both `llms.txt` and `llms-full.txt` list pages from your default language and de This structured approach allows LLMs to efficiently process your documentation at a high level and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches. - - Automatically generated `llms.txt` index files cannot exceed 100,000 characters. For large documentation sites, Mintlify splits the index into linked files under `/_llms/` so agents can discover every page without loading one oversized file. This limit does not apply to `llms-full.txt`. - +## Split indexes under `/_llms` + +Automatically generated `llms.txt` index files cannot exceed 100,000 characters. When an index is larger than this limit, Mintlify keeps the main `llms.txt` file as a directory and moves groups of page links into generated Markdown files under `/_llms/`. This limit does not apply to `llms-full.txt`. + +For example, a large site might link to the following generated index: + +```mdx +- [API reference](https://docs.example.com/_llms/api-reference.md) +``` + +Agents should follow these index links recursively until they reach documentation page links. The generated files are part of `llms.txt` and do not need to exist in your repository. They are separate from `llms-full.txt`. + +The `/_llms/` route uses the same base path as your documentation: + +- A root-hosted site serves an index at `https://docs.example.com/_llms/api-reference.md`. +- A site hosted at `/docs` serves it at `https://example.com/docs/_llms/api-reference.md`. + +If you use a reverse proxy or path allowlist, forward the generated route in addition to `llms.txt`. A broad `/*` rule already includes `/_llms/*`. With granular rules, add `/_llms/*` explicitly. See [Reverse proxy](/deploy/reverse-proxy#routing-configuration) for routing guidance. -If you use a reverse proxy or maintain a path allowlist, forward `/_llms/*` in addition to `/llms.txt` so agents can follow the generated index links. For documentation hosted at a base path, forward `/_llms/*` instead. Mintlify-managed custom domains do not require additional configuration. See [Reverse proxy](/deploy/reverse-proxy#routing-configuration) for routing guidance. + + A directory such as `/docs` in your repository does not set your site's public base path. Configure the base path in your Mintlify dashboard and use the same prefix in your reverse proxy. Otherwise, `llms.txt` can be reachable at the public prefix while its generated `/_llms/` links point somewhere else. + ```mdx Example llms.txt # Site title diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index dce227f18..845ea2c70 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -14,6 +14,8 @@ When you implement a reverse proxy, monitor for potential issues with domain ver Set your base path on the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard. Then configure your reverse proxy to route that path to Mintlify. The default base path is `/docs`, but you can use any base path you choose, like `/help` or `/resources`. +The directory that contains your documentation in your repository does not configure the public base path. For example, storing documentation under a `/docs` directory does not replace setting `/docs` as the base path in your dashboard. + In all configurations, use `mintlify.site` as the proxy target. ## Host at `/docs` subpath @@ -40,6 +42,7 @@ Proxy these paths to your Mintlify subdomain: | --------------------------------- | ------------------------------------ | -------- | | `/docs` | `.mintlify.site/docs` | No cache | | `/docs/*` | `.mintlify.site/docs/*` | No cache | +| `/docs/_llms/*` | `.mintlify.site/docs/_llms/*` | No cache | | `/.well-known/vercel/*` | `.mintlify.site/.well-known/vercel/*` | No cache | | `/.well-known/skills/*` (optional) | `.mintlify.site/docs/.well-known/skills/*` | No cache | | `/.well-known/agent-skills/*` (optional) | `.mintlify.site/docs/.well-known/agent-skills/*` | No cache | @@ -53,6 +56,8 @@ Mintlify serves these files under your base path, like `.mintlif The `/docs/*` route also covers generated `llms.txt` indexes under `/docs/_llms/*`. If your proxy uses a more granular path allowlist instead of forwarding all `/docs/*` requests, include `/docs/_llms/*` so agents can follow every index linked from `/docs/llms.txt`. +Do not rewrite only `/docs/llms.txt` to a root-hosted `/llms.txt`. Set `/docs` as the deployment base path and forward the full `/docs/*` route. This keeps page links and generated `/docs/_llms/*` index links on the same public prefix. + The `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms.txt`, and `/llms-full.txt` routes are optional. Include them only if you also want to serve these files at root paths on your domain, like `your-domain.com/llms.txt`. Each root path maps to the file under your base path on your Mintlify subdomain. ### Required header configuration @@ -204,6 +209,18 @@ Configure your reverse proxy using the same [routing configuration](#routing-con - Remove `Host` header forwarding. - Set the `Origin` header to your Mintlify subdomain (`.mintlify.site`). +### Generated `/_llms/` links return 404 + +**Symptoms**: Your `llms.txt` file loads, but links under `/_llms/` return 404 or omit your public subpath. + +**Cause**: The public subpath does not match the base path configured in Mintlify, or the proxy only forwards `llms.txt` and not its generated index routes. + +**Solution**: + +- Set the public subpath as the base path in your Mintlify dashboard. A repository directory with the same name does not configure it. +- Forward the full `/*` route, or add `/_llms/*` to a granular allowlist. +- Redeploy your documentation, then verify both `/llms.txt` and one linked `/_llms/*.md` URL. + ### Performance issues **Symptoms**: Slow page loads and layout shifts. diff --git a/es/poc-onboarding.mdx b/es/poc-onboarding.mdx index a2e5ae4f5..4c454ee5c 100644 --- a/es/poc-onboarding.mdx +++ b/es/poc-onboarding.mdx @@ -25,8 +25,7 @@ Completa estos pasos en orden: | 4. Publica un cambio | Verifica tu flujo de trabajo de redacción y revisión. | | 5. Aplica tu marca | Alinea el sitio con tu producto. | | 6. Prueba las funciones de IA | Evalúa las respuestas del asistente y un flujo de trabajo de IA. | -| 7. Revisa los requisitos de TI y seguridad | Confirma los requisitos de autenticación y cumplimiento. | -| 8. Revisa los resultados | Compara la POC con tus criterios de éxito. | +| 7. Revisa los resultados | Compara la POC con tus criterios de éxito. | Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite editar, configurar y publicar los archivos `.mdx` y la configuración `docs.json` de ese repositorio. Tu sitio en vivo muestra el resultado publicado. @@ -43,7 +42,7 @@ Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite edit | Responsable de la documentación | Dirige la POC y completa la mayoría de los pasos. | Unas pocas horas en total | | Administrador de GitHub | Aprueba la aplicación de GitHub de Mintlify. | 15 minutos | | Diseñador o responsable de marca | Proporciona logotipos, colores y fuentes. | 30 minutos | -| Administrador de identidad o TI | Configura la autenticación y el DNS, si es necesario. | 1 a 2 horas | +| Administrador de identidad o TI | Configura el DNS para un dominio personalizado, si pruebas la autenticación. | 1 a 2 horas |
### Reúne tu contenido y tus recursos de marca @@ -115,7 +114,7 @@ Comparte el objetivo, la línea base y los criterios con tu AE o SE. -Usa la URL `.mintlify.site` durante la POC, a menos que necesites probar la autenticación. La autenticación requiere un dominio personalizado o un subdominio `*.mintlify.app`. +Usa la URL `.mintlify.site` durante la POC, a menos que necesites probar la autenticación. La autenticación requiere un [dominio personalizado](/es/customize/custom-domain) o un subdominio `*.mintlify.app`, y no funciona en un basepath personalizado como `yourcompany.com/docs`.
## Paso 2: Invita a tu equipo @@ -316,64 +315,8 @@ Elige el flujo de trabajo más relevante para tu evaluación: -
- ## Paso 7: Revisa los requisitos de TI y seguridad -
- -Involucra a tu equipo de TI o seguridad en la POC antes de la revisión final. - - - La autenticación del sitio no funciona en la URL predeterminada `.mintlify.site` ni en un basepath personalizado como `yourcompany.com/docs`. Usa un dominio personalizado o un subdominio `*.mintlify.app`. - - -
- ### Controla el acceso al dashboard -
- -Evalúa los controles que tu equipo requiere: - -- [Inicio de sesión único](/es/dashboard/sso) con SAML u OIDC. -- [Aprovisionamiento de SCIM](/es/dashboard/scim). -- [Políticas de acceso a la red](/es/dashboard/network-access). -- [Registros de auditoría](/es/dashboard/audit-logs) y [seguridad de sesiones](/es/dashboard/session-security). - -
- ### Controla el acceso a la documentación -
- -Configura la [autenticación](/es/deploy/authentication-setup) para tus lectores: - -- **Contraseña:** Control de acceso rápido para una POC. -- **Acceso administrado por Mintlify:** Usa tu organización del dashboard como lista de usuarios. -- **OAuth 2.0:** Se conecta a tu proveedor de identidad. -- **JWT:** Admite modelos de acceso programático personalizados. - -Usa [grupos](/es/deploy/authentication-setup#control-access-with-groups) para restringir páginas específicas: - -```yaml ---- -title: "Production runbook" -groups: ["engineering"] ---- -``` - -Haz la prueba con una cuenta dentro del grupo y otra cuenta fuera de él. - - - `hidden: true` elimina una página de la navegación pero no restringe el acceso. Usa la autenticación y los grupos para el control de acceso. Consulta [Páginas ocultas](/es/organize/hidden-pages). - - -
- ### Completa las verificaciones de infraestructura y cumplimiento -
- -- Agrega un [dominio personalizado](/es/customize/custom-domain). Usa un subdominio de prueba durante la POC. -- Conecta tu [plataforma de analíticas](/es/integrations/analytics/overview). -- Habilita las [comprobaciones de CI](/es/deploy/ci) para enlaces y accesibilidad. -- Comparte [Contratación empresarial](/es/enterprise-contracting) con los equipos de seguridad y compras. - -
- ## Paso 8: Revisa los resultados +
+ ## Paso 7: Revisa los resultados
Reserva una hora con tu responsable de la decisión. Comienza con el objetivo y la línea base que definiste antes de la POC y luego revisa: @@ -387,7 +330,6 @@ Reserva una hora con tu responsable de la decisión. Comienza con el objetivo y | Las brechas de contenido son identificables | Preguntas sin respuesta y con voto negativo en las [analíticas del asistente](/es/analytics/assistant). | | Los lectores encuentran contenido útil | Datos de [tráfico](/es/analytics/traffic), [búsqueda](/es/analytics/search) e [interacción](/es/analytics/user-engagements). | | Las actualizaciones automatizadas son útiles | El historial de ejecuciones de la automatización y el cambio propuesto. | -| Se cumplen los requisitos de seguridad | La revisión de tu equipo de TI. | Resuelve las preguntas pendientes con tu AE o SE antes de esta reunión. @@ -401,7 +343,15 @@ La mayoría de las POC toman dos a tres semanas: |---|---| | Semana 1 | Conecta el repositorio, invita a tu equipo, define el éxito y comienza la migración del contenido. Inicia la configuración del dominio si necesitas autenticación. | | Semana 2 | Revisa el contenido, publica un cambio, aplica tu marca, prueba el asistente y evalúa un flujo de trabajo de IA. | -| Semana 3 | Completa la revisión de TI y seguridad y luego revisa los resultados con tu responsable de la decisión. | +| Semana 3 | Revisa los resultados con tu responsable de la decisión. | + +
+ ## Obtener ayuda +
+ +- Contacta a tu AE o SE para preguntas urgentes sobre la POC. +- Escribe a [support@mintlify.com](mailto:support@mintlify.com) para otras preguntas. +- Consulta [Soporte avanzado](/es/advanced-support) para ver las opciones de soporte después de la POC.
## Después de la POC diff --git a/fr/poc-onboarding.mdx b/fr/poc-onboarding.mdx index 342c1338e..c252df714 100644 --- a/fr/poc-onboarding.mdx +++ b/fr/poc-onboarding.mdx @@ -25,8 +25,7 @@ Effectuez ces étapes dans l'ordre : | 4. Publier une modification | Vérifier votre workflow de rédaction et de revue. | | 5. Appliquer votre image de marque | Aligner le site sur votre produit. | | 6. Tester les fonctionnalités d'IA | Évaluer les réponses de l'assistant et un workflow d'IA. | -| 7. Passer en revue les exigences IT et de sécurité | Confirmer les exigences d'authentification et de conformité. | -| 8. Passer en revue les résultats | Comparer le POC à vos critères de réussite. | +| 7. Passer en revue les résultats | Comparer le POC à vos critères de réussite. | Votre dépôt reste la source de vérité. Le tableau de bord vous permet de modifier, configurer et publier les fichiers `.mdx` et la configuration `docs.json` de ce dépôt. Votre site en ligne affiche le résultat publié. @@ -43,7 +42,7 @@ Votre dépôt reste la source de vérité. Le tableau de bord vous permet de mod | Responsable de la documentation | Pilote le POC et réalise la plupart des étapes. | Quelques heures au total | | Administrateur GitHub | Approuve la GitHub App Mintlify. | 15 minutes | | Designer ou responsable de la marque | Fournit les logos, les couleurs et les polices. | 30 minutes | -| Administrateur des identités ou IT | Configure l'authentification et le DNS, si nécessaire. | 1 à 2 heures | +| Administrateur des identités ou IT | Configure le DNS pour un domaine personnalisé, si vous testez l'authentification. | 1 à 2 heures |
### Rassembler votre contenu et vos éléments de marque @@ -115,7 +114,7 @@ Partagez l'objectif, la valeur de référence et les critères avec votre AE ou -Utilisez l'URL `.mintlify.site` pendant le POC, sauf si vous devez tester l'authentification. L'authentification nécessite un domaine personnalisé ou un sous-domaine `*.mintlify.app`. +Utilisez l'URL `.mintlify.site` pendant le POC, sauf si vous devez tester l'authentification. L'authentification nécessite un [domaine personnalisé](/fr/customize/custom-domain) ou un sous-domaine `*.mintlify.app`, et ne fonctionne pas sur un basepath personnalisé tel que `yourcompany.com/docs`.
## Étape 2 : inviter votre équipe @@ -316,64 +315,8 @@ Choisissez le workflow le plus pertinent pour votre évaluation : -
- ## Étape 7 : passer en revue les exigences IT et de sécurité -
- -Impliquez votre équipe IT ou sécurité dans le POC avant la revue finale. - - - L'authentification du site ne fonctionne pas sur l'URL `.mintlify.site` par défaut ni sur un basepath personnalisé tel que `yourcompany.com/docs`. Utilisez un domaine personnalisé ou un sous-domaine `*.mintlify.app`. - - -
- ### Contrôler l'accès au tableau de bord -
- -Évaluez les contrôles requis par votre équipe : - -- L'[authentification unique](/fr/dashboard/sso) avec SAML ou OIDC. -- Le [provisionnement SCIM](/fr/dashboard/scim). -- Les [politiques d'accès réseau](/fr/dashboard/network-access). -- Les [journaux d'audit](/fr/dashboard/audit-logs) et la [sécurité des sessions](/fr/dashboard/session-security). - -
- ### Contrôler l'accès à la documentation -
- -Configurez l'[authentification](/fr/deploy/authentication-setup) pour vos lecteurs : - -- **Mot de passe :** contrôle d'accès rapide pour un POC. -- **Accès géré par Mintlify :** utilise l'organisation de votre tableau de bord comme liste d'utilisateurs. -- **OAuth 2.0 :** se connecte à votre fournisseur d'identité. -- **JWT :** prend en charge des modèles d'accès programmatiques personnalisés. - -Utilisez les [groupes](/fr/deploy/authentication-setup#control-access-with-groups) pour restreindre certaines pages : - -```yaml ---- -title: "Production runbook" -groups: ["engineering"] ---- -``` - -Testez avec un compte appartenant au groupe et un compte en dehors du groupe. - - - `hidden: true` retire une page de la navigation mais n'en restreint pas l'accès. Utilisez l'authentification et les groupes pour le contrôle d'accès. Consultez [Pages masquées](/fr/organize/hidden-pages). - - -
- ### Effectuer les vérifications d'infrastructure et de conformité -
- -- Ajoutez un [domaine personnalisé](/fr/customize/custom-domain). Utilisez un sous-domaine de test pendant le POC. -- Connectez votre [plateforme d'analyse](/fr/integrations/analytics/overview). -- Activez les [vérifications CI](/fr/deploy/ci) pour les liens et l'accessibilité. -- Partagez [Contrats entreprise](/fr/enterprise-contracting) avec les équipes sécurité et achats. - -
- ## Étape 8 : passer en revue les résultats +
+ ## Étape 7 : passer en revue les résultats
Réservez une heure avec votre décideur. Commencez par l'objectif et la valeur de référence définis avant le POC, puis passez en revue : @@ -387,7 +330,6 @@ Réservez une heure avec votre décideur. Commencez par l'objectif et la valeur | Les lacunes de contenu sont identifiables | Les questions sans réponse et avec vote négatif dans les [analyses de l'assistant](/fr/analytics/assistant). | | Les lecteurs trouvent du contenu utile | Les données de [trafic](/fr/analytics/traffic), de [recherche](/fr/analytics/search) et d'[engagement](/fr/analytics/user-engagements). | | Les mises à jour automatisées sont utiles | L'historique des exécutions de l'automatisation et la modification proposée. | -| Les exigences de sécurité sont satisfaites | La revue de votre équipe IT. | Résolvez les questions en suspens avec votre AE ou SE avant cette réunion. @@ -401,7 +343,15 @@ La plupart des POC durent deux à trois semaines : |---|---| | Semaine 1 | Connecter le dépôt, inviter votre équipe, définir la réussite et démarrer la migration du contenu. Commencer la configuration du domaine si vous avez besoin de l'authentification. | | Semaine 2 | Vérifier le contenu, publier une modification, appliquer l'image de marque, tester l'assistant et évaluer un workflow d'IA. | -| Semaine 3 | Terminer la revue IT et sécurité, puis passer en revue les résultats avec votre décideur. | +| Semaine 3 | Passer en revue les résultats avec votre décideur. | + +
+ ## Obtenir de l'aide +
+ +- Contactez votre AE ou SE pour les questions urgentes liées au POC. +- Écrivez à [support@mintlify.com](mailto:support@mintlify.com) pour toute autre question. +- Consultez [Support avancé](/fr/advanced-support) pour les options de support après le POC.
## Après le POC diff --git a/zh/poc-onboarding.mdx b/zh/poc-onboarding.mdx index f2d974ea0..c5947cf8e 100644 --- a/zh/poc-onboarding.mdx +++ b/zh/poc-onboarding.mdx @@ -25,8 +25,7 @@ noindex: true | 4. 发布一次更改 | 验证你的写作和审查工作流。 | | 5. 应用品牌样式 | 让站点与你的产品保持一致。 | | 6. 测试 AI 功能 | 评估助手的回答和一个 AI 工作流。 | -| 7. 审查 IT 和安全要求 | 确认身份验证和合规要求。 | -| 8. 审查结果 | 将 POC 与你的成功标准进行对比。 | +| 7. 审查结果 | 将 POC 与你的成功标准进行对比。 | 你的仓库始终是唯一数据源。控制面板让你可以编辑、配置和发布该仓库中的 `.mdx` 文件和 `docs.json` 配置。你的线上站点展示发布后的结果。 @@ -43,7 +42,7 @@ noindex: true | 文档负责人 | 主导 POC 并完成大部分步骤。 | 总计几个小时 | | GitHub 管理员 | 批准 Mintlify GitHub 应用。 | 15 分钟 | | 设计师或品牌负责人 | 提供徽标、颜色和字体。 | 30 分钟 | -| 身份或 IT 管理员 | 配置身份验证和 DNS(如需要)。 | 1 到 2 小时 | +| 身份或 IT 管理员 | 如果你要测试身份验证,为自定义域名配置 DNS。 | 1 到 2 小时 |
### 收集你的内容和品牌资产 @@ -115,7 +114,7 @@ noindex: true -除非你需要测试身份验证,否则在 POC 期间请使用 `.mintlify.site` URL。身份验证需要自定义域名或 `*.mintlify.app` 子域名。 +除非你需要测试身份验证,否则在 POC 期间请使用 `.mintlify.site` URL。身份验证需要[自定义域名](/zh/customize/custom-domain)或 `*.mintlify.app` 子域名,并且在自定义基础路径(例如 `yourcompany.com/docs`)上不起作用。
## 第 2 步:邀请你的团队 @@ -316,64 +315,8 @@ noindex: true -
- ## 第 7 步:审查 IT 和安全要求 -
- -在最终审查之前,让你的 IT 或安全团队参与到 POC 中。 - - - 站点身份验证在默认的 `.mintlify.site` URL 或自定义基础路径(例如 `yourcompany.com/docs`)上不起作用。请使用自定义域名或 `*.mintlify.app` 子域名。 - - -
- ### 控制控制面板访问权限 -
- -评估你的团队所需的控制措施: - -- 使用 SAML 或 OIDC 的[单点登录](/zh/dashboard/sso)。 -- [SCIM 配置](/zh/dashboard/scim)。 -- [网络访问策略](/zh/dashboard/network-access)。 -- [审计日志](/zh/dashboard/audit-logs)和[会话安全](/zh/dashboard/session-security)。 - -
- ### 控制文档访问权限 -
- -为你的读者配置[身份验证](/zh/deploy/authentication-setup): - -- **密码:** 适用于 POC 的快速访问控制。 -- **Mintlify 托管访问:** 使用你的控制面板组织作为用户列表。 -- **OAuth 2.0:** 连接到你的身份提供商。 -- **JWT:** 支持自定义的程序化访问模型。 - -使用[群组](/zh/deploy/authentication-setup#control-access-with-groups)限制特定页面: - -```yaml ---- -title: "Production runbook" -groups: ["engineering"] ---- -``` - -分别使用一个属于该群组的账号和一个不属于该群组的账号进行测试。 - - - `hidden: true` 会将页面从导航中移除,但不会限制访问。请使用身份验证和群组进行访问控制。请参阅[隐藏页面](/zh/organize/hidden-pages)。 - - -
- ### 完成基础设施和合规检查 -
- -- 添加[自定义域名](/zh/customize/custom-domain)。在 POC 期间使用测试子域名。 -- 连接你的[分析平台](/zh/integrations/analytics/overview)。 -- 为链接和可访问性启用 [CI 检查](/zh/deploy/ci)。 -- 与安全和采购团队分享[企业合同](/zh/enterprise-contracting)。 - -
- ## 第 8 步:审查结果 +
+ ## 第 7 步:审查结果
与决策者预约一小时的会议。从 POC 前定义的目标和基线开始,然后审查: @@ -387,7 +330,6 @@ groups: ["engineering"] | 可以识别内容缺口 | [助手分析](/zh/analytics/assistant)中未回答和被点踩的问题。 | | 读者能找到有用的内容 | [流量](/zh/analytics/traffic)、[搜索](/zh/analytics/search)和[用户参与](/zh/analytics/user-engagements)数据。 | | 自动更新有价值 | 自动化的运行历史和提出的更改。 | -| 满足安全要求 | 你的 IT 团队的审查结果。 | 在此会议之前,与你的 AE 或 SE 解决所有未决问题。 @@ -401,7 +343,15 @@ groups: ["engineering"] |---|---| | 第 1 周 | 连接仓库、邀请团队、定义成功标准并开始内容迁移。如果需要身份验证,开始域名设置。 | | 第 2 周 | 审查内容、发布一次更改、应用品牌样式、测试助手并评估一个 AI 工作流。 | -| 第 3 周 | 完成 IT 和安全审查,然后与决策者一起审查结果。 | +| 第 3 周 | 与决策者一起审查结果。 | + +
+ ## 获取帮助 +
+ +- 如有紧急的 POC 问题,请联系你的 AE 或 SE。 +- 其他问题请发送邮件至 [support@mintlify.com](mailto:support@mintlify.com)。 +- POC 之后的支持选项请参阅[高级支持](/zh/advanced-support)。
## POC 之后 From 53f082228869beb3d65cc1d27fe0a7e920a79fa4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 22:16:53 +0000 Subject: [PATCH 7/8] docs: fix MDX extension nav path and unify UI verbs on new page --- .../config/vocabularies/Mintlify/accept.txt | 2 +- ai/llmstxt.mdx | 14 +- ai/mintlify-mcp.mdx | 13 ++ cli/index.mdx | 1 + cli/install.mdx | 10 +- cli/mdx-extension.mdx | 143 ++++++++++++++++++ cli/preview.mdx | 4 + docs.json | 1 + es/ai/llmstxt.mdx | 33 +++- es/ai/mintlify-mcp.mdx | 15 ++ es/deploy/reverse-proxy.mdx | 21 +++ fr/ai/llmstxt.mdx | 33 +++- fr/ai/mintlify-mcp.mdx | 15 ++ fr/deploy/reverse-proxy.mdx | 21 +++ poc-onboarding.mdx | 2 +- zh/ai/llmstxt.mdx | 33 +++- zh/ai/mintlify-mcp.mdx | 15 ++ zh/deploy/reverse-proxy.mdx | 21 +++ 18 files changed, 375 insertions(+), 22 deletions(-) create mode 100644 cli/mdx-extension.mdx diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index 575cedf8b..ed010ced0 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -346,7 +346,7 @@ PostgreSQL Postman PowerShell PR -prefetching +(?i)prefetch(es|ed|ing)? prefill(s|ing|ed)? preloaded prepend(ed|ing)? diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index c362042e1..dee993987 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -57,15 +57,21 @@ This structured approach allows LLMs to efficiently process your documentation a ## Split indexes under `/_llms` -Automatically generated `llms.txt` index files cannot exceed 100,000 characters. When an index is larger than this limit, Mintlify keeps the main `llms.txt` file as a directory and moves groups of page links into generated Markdown files under `/_llms/`. This limit does not apply to `llms-full.txt`. +Automatically generated `llms.txt` index files cannot exceed 100,000 characters. When an index is larger than this limit, Mintlify keeps the main `llms.txt` file as a directory and moves groups of page links into generated Markdown files under `/_llms/`. Every page stays discoverable: splitting never omits pages from the index. This limit does not apply to `llms-full.txt`. -For example, a large site might link to the following generated index: +Links to generated indexes appear in an `Indexes` section. Each link includes the group's breadcrumb, its page count, and a description: ```mdx -- [API reference](https://docs.example.com/_llms/api-reference.md) +> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. + +## Indexes + +- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API ``` -Agents should follow these index links recursively until they reach documentation page links. The generated files are part of `llms.txt` and do not need to exist in your repository. They are separate from `llms-full.txt`. +A generated index can link to further indexes. For example, `/_llms/api-reference.md` can link to `/_llms/api-reference/admin.md` when a group is too large for a single file. Agents should follow these index links recursively until they reach documentation page links. Mintlify may shorten page descriptions in a split index to keep each file under the character limit. + +The generated files are part of `llms.txt` and do not need to exist in your repository. They are separate from `llms-full.txt`. The `/_llms/` route uses the same base path as your documentation: diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index fb2ed56c7..690b8ba26 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -132,6 +132,19 @@ Every admin MCP session binds to a single Git branch. The flow is: Calling `checkout` again with a different `subdomain` or branch switches which session is active. It doesn't discard the others. To abandon an in-progress draft instead of switching away from it, call `discard_session`. +## Publishing + +The **Publishing** section on the admin MCP settings page in your dashboard controls what happens when `save` runs with `mode: "auto"`. Toggle **Push directly to your deploy branch** on to have Mintlify push changes straight to your deploy branch. Toggle it off to have `save` open a pull request instead. + +This toggle shares the same `agentReviewProcess` setting as the Slack and dashboard agent, so any change here also applies to those flows. + +The toggle is disabled in two cases: + +- **Your deploy branch requires a pull request.** If branch protection rules or required approvals prevent direct pushes, MCP changes always open a pull request regardless of this setting. +- **Mintlify hosts your deployment.** For Mintlify-hosted sites, MCP changes always push directly, unless branch protection still requires a pull request. + +You can also override the setting on a per-call basis by passing an explicit `mode` to `save`: `"pr"` always opens a pull request, and `"commit"` pushes to an existing PR branch without opening a new PR. + ## What the admin MCP can do ### Content diff --git a/cli/index.mdx b/cli/index.mdx index 5f2eeeb91..ea54fbc3b 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -54,5 +54,6 @@ Run `mint config` to set persistent defaults like your documentation subdomain. ## Next steps - [Install the CLI](/cli/install): Get the CLI installed and ready to use. +- [Mintlify MDX extension](/cli/mdx-extension): Add autocomplete, inline error checking, and an in-editor preview. - [Preview locally](/cli/preview): Run a local development server with search and assistant support. - [Commands](/cli/commands): Complete reference for all commands and flags. diff --git a/cli/install.mdx b/cli/install.mdx index e8fbba5be..6dc89c4bd 100644 --- a/cli/install.mdx +++ b/cli/install.mdx @@ -113,12 +113,14 @@ If `mint update` is not available on your version, reinstall the CLI with the la ``` -## Formatting +## Editor support -For syntax highlighting and code formatting in MDX files, use the following extensions: +For syntax highlighting, autocomplete, and error checking in MDX files, use the following extensions: -- **Cursor, Devin Desktop, VS Code**: [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) -- **JetBrains**: [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) and [Prettier](https://prettier.io/docs/webstorm) +- **Cursor, Devin Desktop, VS Code**: [Mintlify MDX extension](/cli/mdx-extension) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for formatting. +- **JetBrains**: [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) and [Prettier](https://prettier.io/docs/webstorm). + +You can also format MDX files with [`mint format`](/cli/commands#mint-format). ## Troubleshooting diff --git a/cli/mdx-extension.mdx b/cli/mdx-extension.mdx new file mode 100644 index 000000000..96a4f598d --- /dev/null +++ b/cli/mdx-extension.mdx @@ -0,0 +1,143 @@ +--- +title: "Mintlify MDX extension" +description: "Install the Mintlify MDX extension for autocomplete, inline diagnostics, hover documentation, and an in-editor preview while you write MDX locally." +keywords: ["Cursor", "MDX", "autocomplete", "diagnostics", "IntelliSense", "preview", "editor"] +--- + +The Mintlify MDX extension adds language support for Mintlify projects to VS Code, Cursor, Devin Desktop, and other editors that support the VS Code extension API. The extension knows every built-in component and property, so you get autocomplete as you type, and it reports unknown components, invalid properties, and unresolved snippet imports. + +The extension also runs a live preview inside your editor, so you can write and see rendered output without switching to a browser. + +## Prerequisites + +- VS Code 1.85.0 or newer +- A documentation directory with a valid `docs.json` file +- The [Mintlify CLI](/cli/install), for the in-editor preview only + +## Install the extension + +Install from the command line: + +```bash +code --install-extension mintlify.mintlify-snippets +``` + +Or install from within your editor: + +1. Open the Extensions view. +2. Search for `@id:mintlify.mintlify-snippets`. +3. Select **Install**. + +You can also install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). + +The extension activates when you open an `.mdx` file or a workspace containing a `docs.json` file. + +## Autocomplete + +Type `<` to view every built-in component. Autocomplete suggests components' properties and values inside tags. + +The extension suggests components that you import from [reusable snippets](/create/reusable-snippets) alongside built-in ones. + +## Diagnostics + +The extension reports problems in the Problems panel and underlines them in your file as you write: + +- Unknown components. +- Unknown or duplicate properties. +- Invalid values for enumerated properties. +- Missing required properties. +- Unclosed or mismatched tags. +- Unresolved snippet imports. + +These classes of error cause build failures, so fix them as you write to avoid failed deployments. + +To turn diagnostics off, set `mintlify.diagnostics.enabled` to `false`. + +## Hover documentation + +Hover over a component or property to see what it does and a link to its page in the Mintlify documentation. Hovering over a snippet component previews the contents of the snippet file. + +## Go to definition + +Hold CMD (macOS) or CTRL (Windows) and click to navigate to the definition of: + +- Snippet components. +- Import paths. +- `href` and `src` attributes that point to local pages. + +The extension finds your docs root by walking up from the open file until it finds `docs.json`, so absolute imports like `/snippets/example.mdx` resolve correctly. The detected project appears in the status bar. To check which root the extension is using, run **Mintlify: Show detected docs root** from the command palette. + +## Configuration validation + +The extension validates `docs.json` against the [Mintlify schema](https://mintlify.com/docs.json). + +## Preview in your editor + +Open an `.mdx` file and select the preview icon in the editor title bar, or right-click the file and select **Preview Mintlify**. A preview panel opens beside your editor and renders the page. + +In-editor previews require the [Mintlify CLI](/cli/install). The URL of the running server appears in the status bar. Select it to stop the server, or run **Mintlify: Stop preview server**. + +To see the output of the underlying `mint dev` process, open the **Mintlify Preview** output channel. + + + Use the in-editor preview while you write individual pages, and [`mint dev`](/cli/preview) in a browser when you want to test navigation, search, or authentication across your whole site. + + +## Wrap content in components + +The extension includes snippets that wrap selected text in a component, rather than inserting an empty component for you to fill in. + +To use them, select the content you want to wrap, then run **Snippets: Surround With** from the command palette and select a component. Snippets are available for `AccordionGroup`, `CardGroup`, `CodeGroup`, `Expandable`, `Frame`, `RequestExample`, `ResponseExample`, and fenced code blocks. + +## Settings + +| Setting | Default | Description | +| --- | --- | --- | +| `mintlify.diagnostics.enabled` | `true` | Report unknown components, unknown properties, missing required properties, and unresolved snippet imports. | +| `mintlify.warnAboutConflictingExtensions` | `true` | Warn when you have another MDX extension installed alongside the Mintlify MDX extension. | +| `mintlify.preview.command` | `mint dev --no-open` | Command used to start the preview server, run from your project root. | +| `mintlify.preview.followScroll` | `true` | Scroll the preview to the heading nearest the top of your editor. | + +`mintlify.preview.command` is a user setting, so a workspace cannot override it. This prevents a cloned repository from running an arbitrary command on your machine when you open a preview. + +## Commands + +Run these from the command palette: + +| Command | Description | +| --- | --- | +| **Mintlify: Preview Mintlify** | Open the preview panel for the current file. | +| **Mintlify: Stop preview server** | Stop the running preview server. | +| **Mintlify: Show detected docs root** | Show which `docs.json` file the extension resolved. | +| **Mintlify: Open component docs** | Open the documentation for the component at your cursor. | +| **Mintlify: Restart language server** | Restart the language server. | + +## Conflicting extensions + +Other MDX extensions provide their own syntax highlighting and language features for `.mdx` files, which conflict with this extension. Disable other MDX extensions to avoid duplicate suggestions and inconsistent highlighting. + +For code formatting, use [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) alongside this extension or run [`mint format`](/cli/commands#mint-format). + +## Troubleshooting + + + + The extension resolves components relative to your docs root. Run **Mintlify: Show detected docs root** to confirm it found the correct `docs.json` file. If the root is wrong or missing, open the folder containing your `docs.json` file as your workspace. + + If the root is correct, run **Mintlify: Restart language server**. + + + Another MDX extension is likely also active. Open the Extensions view, search for `mdx`, and disable any other MDX extensions in this workspace. + + + Open the **Mintlify Preview** output channel to see the error from `mint dev`. + + - `could not run "mint dev --no-open"`: The CLI is not installed. Install it with `npm i -g mint`. + - `Trust the workspace first`: Trust the workspace through **Manage Workspace Trust**. + - `no docs.json found above this file`: Open the folder containing your `docs.json` file as your workspace. + - `Invalid docs.json`: Run [`mint validate`](/cli/commands#mint-validate) to find the configuration error. + + + Absolute import paths resolve from your docs root, not from your file. Confirm the path matches the location of the snippet file relative to your `docs.json` file, and that the detected root is correct. + + diff --git a/cli/preview.mdx b/cli/preview.mdx index a7263ca9d..c8bbadc04 100644 --- a/cli/preview.mdx +++ b/cli/preview.mdx @@ -31,6 +31,10 @@ To generate a preview without installing the CLI globally, run: npx mint dev ``` + + If you write in VS Code or Cursor, the [Mintlify MDX extension](/cli/mdx-extension) runs this preview in a panel beside your editor and scrolls it to match the page you are editing. + + ## Log in for search and assistant You must authenticate the CLI with your Mintlify account to enable search and the [assistant](/assistant/index). diff --git a/docs.json b/docs.json index c643ccf21..a917458ea 100644 --- a/docs.json +++ b/docs.json @@ -37,6 +37,7 @@ "root": "cli/index", "pages": [ "cli/install", + "cli/mdx-extension", "cli/preview", "cli/commands" ] diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index c6ac44645..fb173516a 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -57,11 +57,36 @@ Tanto `llms.txt` como `llms-full.txt` listan las páginas de tu idioma predeterm Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA. - - Los archivos de índice `llms.txt` generados automáticamente no pueden superar los 100.000 caracteres. Para sitios de documentación grandes, Mintlify divide el índice en archivos enlazados bajo `/_llms/` para que los agentes puedan descubrir cada página sin cargar un único archivo demasiado grande. Este límite no se aplica a `llms-full.txt`. - +
+ ## Índices divididos bajo `/_llms` +
+ +Los archivos de índice `llms.txt` generados automáticamente no pueden superar los 100.000 caracteres. Cuando un índice supera este límite, Mintlify mantiene el archivo `llms.txt` principal como un directorio y traslada grupos de enlaces de páginas a archivos Markdown generados bajo `/_llms/`. Todas las páginas siguen siendo descubribles: la división nunca omite páginas del índice. Este límite no se aplica a `llms-full.txt`. + +Los enlaces a los índices generados aparecen en una sección `Indexes`. Cada enlace incluye la ruta de navegación del grupo, su número de páginas y una descripción: + +```mdx +> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. + +## Indexes + +- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API +``` + +Un índice generado puede enlazar a otros índices. Por ejemplo, `/_llms/api-reference.md` puede enlazar a `/_llms/api-reference/admin.md` cuando un grupo es demasiado grande para un solo archivo. Los agentes deben seguir estos enlaces de índice de forma recursiva hasta llegar a los enlaces de las páginas de documentación. Mintlify puede acortar las descripciones de las páginas en un índice dividido para mantener cada archivo por debajo del límite de caracteres. + +Los archivos generados forman parte de `llms.txt` y no necesitan existir en tu repositorio. Son independientes de `llms-full.txt`. + +La ruta `/_llms/` usa la misma ruta base que tu documentación: + +- Un sitio alojado en la raíz sirve un índice en `https://docs.example.com/_llms/api-reference.md`. +- Un sitio alojado en `/docs` lo sirve en `https://example.com/docs/_llms/api-reference.md`. + +Si utilizas un proxy inverso o una lista de rutas permitidas, reenvía la ruta generada además de `llms.txt`. Una regla amplia `/*` ya incluye `/_llms/*`. Con reglas granulares, añade `/_llms/*` de forma explícita. Consulta [Proxy inverso](/es/deploy/reverse-proxy#routing-configuration) para obtener orientación sobre el enrutamiento. -Si utilizas un proxy inverso o mantienes una lista de rutas permitidas, reenvía `/_llms/*` además de `/llms.txt` para que los agentes puedan seguir los enlaces del índice generado. Para documentación alojada en una ruta base, reenvía `/_llms/*` en su lugar. Los dominios personalizados gestionados por Mintlify no requieren configuración adicional. Consulta [Proxy inverso](/es/deploy/reverse-proxy#routing-configuration) para obtener orientación sobre el enrutamiento. + + Un directorio como `/docs` en tu repositorio no establece la ruta base pública de tu sitio. Configura la ruta base en tu dashboard de Mintlify y usa el mismo prefijo en tu proxy inverso. De lo contrario, `llms.txt` puede ser accesible en el prefijo público mientras sus enlaces generados bajo `/_llms/` apuntan a otro lugar. + ```mdx Example llms.txt # Título del sitio diff --git a/es/ai/mintlify-mcp.mdx b/es/ai/mintlify-mcp.mdx index 1f8d72ff4..cd7006802 100644 --- a/es/ai/mintlify-mcp.mdx +++ b/es/ai/mintlify-mcp.mdx @@ -142,6 +142,21 @@ Cada sesión del Admin MCP se vincula a una sola rama de Git. El flujo es: Llamar a `checkout` de nuevo con un `subdomain` o una rama distinta cambia qué sesión está activa. No descarta las demás. Para abandonar un borrador en curso en lugar de simplemente alejarte de él, llama a `discard_session`. +
+ ## Publicación +
+ +La sección **Publicación** en la página de configuración del Admin MCP de tu panel controla qué ocurre cuando `save` se ejecuta con `mode: "auto"`. Activa **Enviar directamente a tu rama de despliegue** para que Mintlify envíe los cambios directamente a tu rama de despliegue. Desactívalo para que `save` abra una pull request en su lugar. + +Este interruptor comparte el mismo ajuste `agentReviewProcess` que los agentes de Slack y del panel, por lo que cualquier cambio aquí también se aplica a esos flujos. + +El interruptor se deshabilita en dos casos: + +- **Tu rama de despliegue requiere una pull request.** Si las reglas de protección de rama o las aprobaciones requeridas impiden los push directos, los cambios del MCP siempre abren una pull request, independientemente de este ajuste. +- **Mintlify aloja tu implementación.** Para los sitios alojados por Mintlify, los cambios del MCP siempre se envían directamente, a menos que la protección de rama aún requiera una pull request. + +También puedes anular el ajuste caso por caso pasando un `mode` explícito a `save`: `"pr"` siempre abre una pull request, y `"commit"` hace push a una rama de PR existente sin abrir una nueva PR. +
## Qué puede hacer el Admin MCP
diff --git a/es/deploy/reverse-proxy.mdx b/es/deploy/reverse-proxy.mdx index feb262efc..42ce33171 100644 --- a/es/deploy/reverse-proxy.mdx +++ b/es/deploy/reverse-proxy.mdx @@ -16,6 +16,8 @@ Al implementar un proxy inverso, supervisa posibles problemas con la verificaci Configura tu ruta base en la página de [configuración de dominio personalizado](https://app.mintlify.com/settings/deployment/custom-domain) en tu dashboard y, luego, configura tu proxy inverso para enrutar esa ruta a Mintlify. La ruta base predeterminada es `/docs`, pero puedes usar cualquier ruta base que elijas, como `/help` o `/resources`. +El directorio que contiene tu documentación en tu repositorio no configura la ruta base pública. Por ejemplo, almacenar la documentación en un directorio `/docs` no sustituye establecer `/docs` como ruta base en tu dashboard. + En todas las configuraciones, usa `mintlify.site` como destino del proxy.
@@ -46,6 +48,7 @@ Redirige mediante proxy estas rutas a tu subdominio de Mintlify: | --------------------------------- | ------------------------------------ | -------- | | `/docs` | `.mintlify.site/docs` | Sin caché | | `/docs/*` | `.mintlify.site/docs/*` | Sin caché | +| `/docs/_llms/*` | `.mintlify.site/docs/_llms/*` | Sin caché | | `/.well-known/vercel/*` | `.mintlify.site/.well-known/vercel/*` | Sin caché | | `/.well-known/skills/*` (opcional) | `.mintlify.site/docs/.well-known/skills/*` | Sin caché | | `/.well-known/agent-skills/*` (opcional) | `.mintlify.site/docs/.well-known/agent-skills/*` | Sin caché | @@ -57,6 +60,10 @@ Tu proxy debe reenviar todos los métodos HTTP en las rutas de documentación. M Mintlify sirve estos archivos bajo tu ruta base, como `.mintlify.site/docs/llms.txt`, de modo que están disponibles en tu dominio bajo tu subruta, como `your-domain.com/docs/llms.txt`, a través de tu ruta de subruta principal. +La ruta `/docs/*` también cubre los índices `llms.txt` generados bajo `/docs/_llms/*`. Si tu proxy usa una lista de rutas permitidas más granular en lugar de reenviar todas las solicitudes de `/docs/*`, incluye `/docs/_llms/*` para que los agentes puedan seguir todos los índices enlazados desde `/docs/llms.txt`. + +No reescribas solo `/docs/llms.txt` hacia un `/llms.txt` alojado en la raíz. Establece `/docs` como la ruta base del despliegue y reenvía la ruta completa `/docs/*`. Esto mantiene los enlaces de las páginas y los enlaces de índice generados bajo `/docs/_llms/*` en el mismo prefijo público. + Las rutas `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms.txt` y `/llms-full.txt` son opcionales. Inclúyelas solo si también quieres servir estos archivos en rutas raíz de tu dominio, como `your-domain.com/llms.txt`. Ten en cuenta que cada ruta raíz se mapea al archivo bajo tu ruta base en tu subdominio de Mintlify.
@@ -220,6 +227,20 @@ Configura tu proxy inverso usando la misma [configuración de enrutamiento](#rou - Elimina el reenvío del encabezado `Host` - Configura el encabezado `Origin` con tu subdominio de Mintlify (`.mintlify.site`) + + +**Síntomas**: Tu archivo `llms.txt` carga, pero los enlaces bajo `/_llms/` devuelven 404 u omiten tu subruta pública. + +**Causa**: La subruta pública no coincide con la ruta base configurada en Mintlify, o el proxy solo reenvía `llms.txt` y no sus rutas de índice generadas. + +**Solución**: + +- Establece la subruta pública como ruta base en tu dashboard de Mintlify. Un directorio del repositorio con el mismo nombre no la configura. +- Reenvía la ruta completa `/*` o añade `/_llms/*` a una lista de rutas permitidas granular. +- Vuelve a desplegar tu documentación y luego verifica tanto `/llms.txt` como una URL enlazada `/_llms/*.md`. +
### Problemas de rendimiento
diff --git a/fr/ai/llmstxt.mdx b/fr/ai/llmstxt.mdx index 0b904befc..a5f9130c0 100644 --- a/fr/ai/llmstxt.mdx +++ b/fr/ai/llmstxt.mdx @@ -57,11 +57,36 @@ Les fichiers `llms.txt` et `llms-full.txt` répertorient les pages de votre lang Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l'IA. - - Les fichiers d'index `llms.txt` générés automatiquement ne peuvent pas dépasser 100 000 caractères. Pour les sites de documentation volumineux, Mintlify scinde l'index en fichiers liés sous `/_llms/` afin que les agents puissent découvrir chaque page sans charger un seul fichier trop volumineux. Cette limite ne s'applique pas à `llms-full.txt`. - +
+ ## Index scindés sous `/_llms` +
+ +Les fichiers d'index `llms.txt` générés automatiquement ne peuvent pas dépasser 100 000 caractères. Lorsqu'un index dépasse cette limite, Mintlify conserve le fichier `llms.txt` principal comme répertoire et déplace des groupes de liens de pages vers des fichiers Markdown générés sous `/_llms/`. Chaque page reste découvrable : la scission n'omet jamais de pages de l'index. Cette limite ne s'applique pas à `llms-full.txt`. + +Les liens vers les index générés apparaissent dans une section `Indexes`. Chaque lien inclut le fil d'Ariane du groupe, son nombre de pages et une description : + +```mdx +> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. + +## Indexes + +- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API +``` + +Un index généré peut pointer vers d'autres index. Par exemple, `/_llms/api-reference.md` peut pointer vers `/_llms/api-reference/admin.md` lorsqu'un groupe est trop volumineux pour un seul fichier. Les agents doivent suivre ces liens d'index de manière récursive jusqu'à atteindre les liens des pages de documentation. Mintlify peut raccourcir les descriptions de pages dans un index scindé pour maintenir chaque fichier sous la limite de caractères. + +Les fichiers générés font partie de `llms.txt` et n'ont pas besoin d'exister dans votre référentiel. Ils sont distincts de `llms-full.txt`. + +La route `/_llms/` utilise le même chemin de base que votre documentation : + +- Un site hébergé à la racine sert un index à l'adresse `https://docs.example.com/_llms/api-reference.md`. +- Un site hébergé sous `/docs` le sert à l'adresse `https://example.com/docs/_llms/api-reference.md`. + +Si vous utilisez un reverse proxy ou une liste d'autorisation de chemins, transférez la route générée en plus de `llms.txt`. Une règle large `/*` inclut déjà `/_llms/*`. Avec des règles granulaires, ajoutez explicitement `/_llms/*`. Consultez [Reverse proxy](/fr/deploy/reverse-proxy#routing-configuration) pour des conseils de routage. -Si vous utilisez un reverse proxy ou maintenez une liste d'autorisation de chemins, transférez `/_llms/*` en plus de `/llms.txt` pour que les agents puissent suivre les liens de l'index généré. Pour une documentation hébergée sous un chemin de base, transférez `/_llms/*` à la place. Les domaines personnalisés gérés par Mintlify ne nécessitent aucune configuration supplémentaire. Consultez [Reverse proxy](/fr/deploy/reverse-proxy#routing-configuration) pour des conseils de routage. + + Un répertoire tel que `/docs` dans votre référentiel ne définit pas le chemin de base public de votre site. Configurez le chemin de base dans votre Dashboard Mintlify et utilisez le même préfixe dans votre reverse proxy. Sinon, `llms.txt` peut être accessible au préfixe public alors que ses liens `/_llms/` générés pointent ailleurs. + ```mdx Example llms.txt # Titre du site diff --git a/fr/ai/mintlify-mcp.mdx b/fr/ai/mintlify-mcp.mdx index 9f9055a57..c0fb73ccd 100644 --- a/fr/ai/mintlify-mcp.mdx +++ b/fr/ai/mintlify-mcp.mdx @@ -142,6 +142,21 @@ Chaque session Admin MCP est liée à une seule branche Git. Le flux est le suiv Appeler `checkout` à nouveau avec un `subdomain` ou une branche différente change la session active. Cela ne supprime pas les autres. Pour abandonner un brouillon en cours plutôt que de simplement en changer, appelez `discard_session`. +
+ ## Publication +
+ +La section **Publication** de la page des paramètres de l'Admin MCP dans votre tableau de bord contrôle ce qui se passe lorsque `save` s'exécute avec `mode: "auto"`. Activez **Pousser directement sur votre branche de déploiement** pour que Mintlify pousse les modifications directement sur votre branche de déploiement. Désactivez-la pour que `save` ouvre une pull request à la place. + +Ce bouton partage le même paramètre `agentReviewProcess` que l'agent Slack et l'agent du tableau de bord, donc toute modification ici s'applique également à ces flux. + +Le bouton est désactivé dans deux cas : + +- **Votre branche de déploiement requiert une pull request.** Si des règles de protection de branche ou des approbations requises empêchent les push directs, les modifications MCP ouvrent toujours une pull request, quel que soit ce paramètre. +- **Mintlify héberge votre déploiement.** Pour les sites hébergés par Mintlify, les modifications MCP sont toujours poussées directement, sauf si la protection de branche exige tout de même une pull request. + +Vous pouvez également remplacer ce paramètre appel par appel en passant un `mode` explicite à `save` : `"pr"` ouvre toujours une pull request, et `"commit"` pousse sur une branche de PR existante sans ouvrir de nouvelle PR. +
## Ce que l'Admin MCP peut faire
diff --git a/fr/deploy/reverse-proxy.mdx b/fr/deploy/reverse-proxy.mdx index ed1a061a5..4a150650e 100644 --- a/fr/deploy/reverse-proxy.mdx +++ b/fr/deploy/reverse-proxy.mdx @@ -16,6 +16,8 @@ Lorsque vous mettez en place un proxy inverse, surveillez les problèmes potenti Définissez votre chemin de base sur la page [Configuration du domaine personnalisé](https://app.mintlify.com/settings/deployment/custom-domain) de votre Dashboard, puis configurez votre proxy inverse pour acheminer ce chemin vers Mintlify. Le chemin de base par défaut est `/docs`, mais vous pouvez utiliser n’importe quel chemin de base de votre choix, comme `/help` ou `/resources`. +Le répertoire qui contient votre documentation dans votre référentiel ne configure pas le chemin de base public. Par exemple, stocker la documentation dans un répertoire `/docs` ne remplace pas la définition de `/docs` comme chemin de base dans votre Dashboard. + Dans toutes les configurations, utilisez `mintlify.site` comme cible du proxy.
@@ -46,6 +48,7 @@ Redirigez ces chemins via un proxy vers votre sous-domaine Mintlify : | --------------------------------- | ------------------------------------ | -------- | | `/docs` | `.mintlify.site/docs` | No cache | | `/docs/*` | `.mintlify.site/docs/*` | No cache | +| `/docs/_llms/*` | `.mintlify.site/docs/_llms/*` | No cache | | `/.well-known/vercel/*` | `.mintlify.site/.well-known/vercel/*` | No cache | | `/.well-known/skills/*` (optional) | `.mintlify.site/docs/.well-known/skills/*` | No cache | | `/.well-known/agent-skills/*` (optional) | `.mintlify.site/docs/.well-known/agent-skills/*` | No cache | @@ -57,6 +60,10 @@ Votre proxy doit transmettre toutes les méthodes HTTP sur les chemins de docume Mintlify sert ces fichiers sous votre chemin de base, comme `.mintlify.site/docs/llms.txt`, ils sont donc disponibles sur votre domaine sous votre sous-chemin, comme `your-domain.com/docs/llms.txt`, via votre route principale de sous-chemin. +La route `/docs/*` couvre également les index `llms.txt` générés sous `/docs/_llms/*`. Si votre proxy utilise une liste d'autorisation de chemins plus granulaire au lieu de transférer toutes les requêtes `/docs/*`, incluez `/docs/_llms/*` afin que les agents puissent suivre chaque index lié depuis `/docs/llms.txt`. + +Ne réécrivez pas uniquement `/docs/llms.txt` vers un `/llms.txt` hébergé à la racine. Définissez `/docs` comme chemin de base du déploiement et transférez la route `/docs/*` complète. Cela maintient les liens de pages et les liens d'index `/docs/_llms/*` générés sur le même préfixe public. + Les routes `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms.txt` et `/llms-full.txt` sont facultatives. Ne les incluez que si vous souhaitez également servir ces fichiers à des chemins racine sur votre domaine, comme `your-domain.com/llms.txt`. Notez que chaque chemin racine correspond au fichier situé sous votre chemin de base sur votre sous-domaine Mintlify.
@@ -220,6 +227,20 @@ Configurez votre proxy inverse en utilisant la même [configuration de routage]( - Supprimez le transfert de l’en-tête `Host` - Définissez l’en-tête `Origin` sur votre sous-domaine Mintlify (`.mintlify.site`) + + +**Symptômes** : votre fichier `llms.txt` se charge, mais les liens sous `/_llms/` renvoient une erreur 404 ou omettent votre sous-chemin public. + +**Cause** : le sous-chemin public ne correspond pas au chemin de base configuré dans Mintlify, ou le proxy ne transfère que `llms.txt` et non ses routes d'index générées. + +**Solution** : + +- Définissez le sous-chemin public comme chemin de base dans votre Dashboard Mintlify. Un répertoire du référentiel portant le même nom ne le configure pas. +- Transférez la route `/*` complète, ou ajoutez `/_llms/*` à une liste d'autorisation granulaire. +- Redéployez votre documentation, puis vérifiez à la fois `/llms.txt` et une URL `/_llms/*.md` liée. +
### Problèmes de performances
diff --git a/poc-onboarding.mdx b/poc-onboarding.mdx index 14733a9e8..793d2c5f7 100644 --- a/poc-onboarding.mdx +++ b/poc-onboarding.mdx @@ -114,7 +114,7 @@ Open the [Members](https://app.mintlify.com/settings/organization/members) page See [Roles](/dashboard/roles) for a complete permissions list. -Invite at least one writer who does not use Git, one engineer, and the decision maker. Use their work email addresses so their accounts can connect to your identity provider. +Invite at least one writer who does not use Git, one engineer, and the decision maker. Use their work email addresses so their accounts can connect to your identity provider if you test authentication. ## Step 3: Add sample content diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index 354db76cc..fe5f875ac 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -57,11 +57,36 @@ X-Llms-Txt: /llms.txt 这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档,并为用户查询定位相关内容,从而提升 AI 辅助文档搜索的准确性和速度。 - - 自动生成的 `llms.txt` 索引文件不能超过 100,000 个字符。对于大型文档站点,Mintlify 会将索引拆分为位于 `/_llms/` 下的多个链接文件,使代理无需加载单个超大文件即可发现所有页面。此限制不适用于 `llms-full.txt`。 - +
+ ## `/_llms` 下的拆分索引 +
+ +自动生成的 `llms.txt` 索引文件不能超过 100,000 个字符。当索引超过此限制时,Mintlify 会将主 `llms.txt` 文件保留为目录形式,并将成组的页面链接移入位于 `/_llms/` 下的生成 Markdown 文件中。所有页面仍然可被发现:拆分绝不会从索引中省略页面。此限制不适用于 `llms-full.txt`。 + +指向生成索引的链接会出现在 `Indexes` 部分。每个链接都包含该分组的面包屑路径、页面数量和描述: + +```mdx +> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. + +## Indexes + +- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API +``` + +生成的索引可以链接到更深层的索引。例如,当某个分组过大而无法放入单个文件时,`/_llms/api-reference.md` 可以链接到 `/_llms/api-reference/admin.md`。代理应递归跟随这些索引链接,直至到达文档页面链接。Mintlify 可能会缩短拆分索引中的页面描述,以使每个文件保持在字符限制以内。 + +这些生成的文件属于 `llms.txt` 的一部分,无需存在于你的仓库中。它们与 `llms-full.txt` 相互独立。 + +`/_llms/` 路由使用与你的文档相同的基础路径: + +- 托管在根路径下的站点会在 `https://docs.example.com/_llms/api-reference.md` 提供索引。 +- 托管在 `/docs` 下的站点会在 `https://example.com/docs/_llms/api-reference.md` 提供索引。 + +如果你使用反向代理或路径允许列表,请在转发 `llms.txt` 的同时转发生成的路由。宽泛的 `/*` 规则已经包含 `/_llms/*`。如果使用细粒度规则,请显式添加 `/_llms/*`。有关路由指引,请参见[反向代理](/zh/deploy/reverse-proxy#routing-configuration)。 -如果你使用反向代理或维护路径允许列表,请在转发 `/llms.txt` 的同时转发 `/_llms/*`,以便代理能够跟随生成的索引链接。对于托管在基础路径下的文档,改为转发 `/_llms/*`。由 Mintlify 管理的自定义域名无需额外配置。有关路由指引,请参见[反向代理](/zh/deploy/reverse-proxy#routing-configuration)。 + + 仓库中诸如 `/docs` 之类的目录不会设置站点的公开基础路径。请在 Mintlify 控制台中配置基础路径,并在反向代理中使用相同的前缀。否则,`llms.txt` 可能可以通过公开前缀访问,而其生成的 `/_llms/` 链接却指向其他位置。 + ```mdx Example llms.txt # 站点标题 diff --git a/zh/ai/mintlify-mcp.mdx b/zh/ai/mintlify-mcp.mdx index 8c87f729b..e95775ccc 100644 --- a/zh/ai/mintlify-mcp.mdx +++ b/zh/ai/mintlify-mcp.mdx @@ -142,6 +142,21 @@ keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor", 使用不同的 `subdomain` 或 branch 再次调用 `checkout` 会切换当前活动的会话,而不会丢弃其他会话。若要放弃进行中的草稿而不仅仅是切换离开它,请调用 `discard_session`。 +
+ ## 发布 +
+ +控制台管理员 MCP 设置页面上的 **发布** 部分用于控制 `save` 在 `mode: "auto"` 下运行时的行为。开启 **直接推送到你的部署 branch**,Mintlify 会将更改直接推送到你的部署 branch。关闭它,`save` 将改为打开一个拉取请求。 + +此开关与 Slack 和控制台代理共享相同的 `agentReviewProcess` 设置,因此在这里所做的任何更改都会同样应用于那些流程。 + +以下两种情况下该开关会被禁用: + +- **你的部署 branch 需要拉取请求。** 如果 branch 保护规则或必需的审批阻止了直接推送,那么无论此设置如何,MCP 更改都会始终打开拉取请求。 +- **Mintlify 托管你的部署。** 对于由 Mintlify 托管的站点,MCP 更改会始终直接推送,除非 branch 保护仍然要求拉取请求。 + +你也可以通过向 `save` 传递显式的 `mode` 来按调用覆盖该设置:`"pr"` 始终打开拉取请求,`"commit"` 会推送到现有的 PR branch 而不打开新的 PR。 +
## 管理员 MCP 可以做什么
diff --git a/zh/deploy/reverse-proxy.mdx b/zh/deploy/reverse-proxy.mdx index 86a7693c9..cb5e7e5dd 100644 --- a/zh/deploy/reverse-proxy.mdx +++ b/zh/deploy/reverse-proxy.mdx @@ -16,6 +16,8 @@ import SubpathSetupSteps from "/snippets/zh/subpath-setup-steps.mdx"; 在控制台的 [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) 页面上设置你的基础路径,然后将反向代理配置为把该路径路由到 Mintlify。默认基础路径是 `/docs`,但你可以使用任何你选择的基础路径,例如 `/help` 或 `/resources`。 +仓库中存放文档的目录并不会配置公开基础路径。例如,将文档存放在 `/docs` 目录下并不能替代在控制台中将 `/docs` 设置为基础路径。 + 在所有配置中,均使用 `mintlify.site` 作为代理目标。
@@ -46,6 +48,7 @@ import SubpathSetupSteps from "/snippets/zh/subpath-setup-steps.mdx"; | --------------------------------- | ------------------------------------ | -------- | | `/docs` | `.mintlify.site/docs` | No cache | | `/docs/*` | `.mintlify.site/docs/*` | No cache | +| `/docs/_llms/*` | `.mintlify.site/docs/_llms/*` | No cache | | `/.well-known/vercel/*` | `.mintlify.site/.well-known/vercel/*` | No cache | | `/.well-known/skills/*` (可选) | `.mintlify.site/docs/.well-known/skills/*` | No cache | | `/.well-known/agent-skills/*` (可选) | `.mintlify.site/docs/.well-known/agent-skills/*` | No cache | @@ -57,6 +60,10 @@ import SubpathSetupSteps from "/snippets/zh/subpath-setup-steps.mdx"; Mintlify 会在你的基础路径下提供这些文件,例如 `.mintlify.site/docs/llms.txt`,因此它们可以通过你的主要子路径路由,在你域名的子路径下访问,例如 `your-domain.com/docs/llms.txt`。 +`/docs/*` 路由同样覆盖位于 `/docs/_llms/*` 下生成的 `llms.txt` 索引。如果你的代理使用更细粒度的路径允许列表,而不是转发所有 `/docs/*` 请求,请包含 `/docs/_llms/*`,以便代理能够跟随 `/docs/llms.txt` 中链接的每个索引。 + +不要仅将 `/docs/llms.txt` 重写为托管在根路径的 `/llms.txt`。请将 `/docs` 设置为部署基础路径,并转发完整的 `/docs/*` 路由。这样可以让页面链接与生成的 `/docs/_llms/*` 索引链接保持在同一个公开前缀下。 + `/.well-known/skills/*`、`/.well-known/agent-skills/*`、`/skill.md`、`/llms.txt` 和 `/llms-full.txt` 路由是可选的。只有当你还希望在域名的根路径下提供这些文件时(例如 `your-domain.com/llms.txt`)才需要包含它们。请注意,每个根路径都会映射到你 Mintlify 子域上基础路径下的文件。
@@ -220,6 +227,20 @@ Mintlify 会重新构建你的文档以在你的基础路径下提供服务, - 停止转发 `Host` 头 - 将 `Origin` 头设置为你的 Mintlify 子域(`.mintlify.site`) + + +**症状**:`llms.txt` 文件可以加载,但 `/_llms/` 下的链接返回 404 或缺少你的公开子路径。 + +**原因**:公开子路径与在 Mintlify 中配置的基础路径不匹配,或者代理仅转发了 `llms.txt` 而没有转发其生成的索引路由。 + +**解决方案**: + +- 在 Mintlify 控制台中将公开子路径设置为基础路径。仓库中同名的目录并不会配置基础路径。 +- 转发完整的 `/*` 路由,或在细粒度允许列表中添加 `/_llms/*`。 +- 重新部署文档,然后同时验证 `/llms.txt` 和一个链接的 `/_llms/*.md` URL。 +
### 性能问题
From ceeb62b76bfe84759494be4f03ae3ff21932fa4f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 02:43:35 +0000 Subject: [PATCH 8/8] docs: sync with editor overhaul and split long sentence in review page --- .../config/vocabularies/Mintlify/accept.txt | 5 +- changelog.mdx | 14 +- deploy/authentication-setup.mdx | 2 +- docs.json | 10 +- editor/agent.mdx | 18 +- editor/branching-and-publishing.mdx | 192 ------------ editor/collaborate.mdx | 66 +++++ editor/comments.mdx | 97 ------- editor/configurations.mdx | 198 ------------- editor/git-essentials.mdx | 72 ----- editor/index.mdx | 128 ++++---- editor/keyboard-shortcuts.mdx | 12 +- editor/live-preview.mdx | 53 ---- editor/navigation.mdx | 44 --- editor/pages.mdx | 182 +++--------- editor/publish.mdx | 72 +++++ editor/review.mdx | 82 ++++++ editor/settings.mdx | 145 ++++----- editor/suggestions.mdx | 50 ---- es.json | 11 +- es/changelog.mdx | 10 +- es/cli/index.mdx | 1 + es/cli/install.mdx | 12 +- es/cli/mdx-extension.mdx | 169 +++++++++++ es/cli/preview.mdx | 4 + es/deploy/authentication-setup.mdx | 2 +- es/editor/agent.mdx | 70 ++--- es/editor/branching-and-publishing.mdx | 264 ----------------- es/editor/collaborate.mdx | 82 ++++++ es/editor/comments.mdx | 108 ------- es/editor/configurations.mdx | 274 ------------------ es/editor/git-essentials.mdx | 84 ------ es/editor/index.mdx | 124 ++++---- es/editor/keyboard-shortcuts.mdx | 70 +++-- es/editor/live-preview.mdx | 69 ----- es/editor/media.mdx | 100 ------- es/editor/navigation.mdx | 49 ---- es/editor/pages.mdx | 242 +++------------- es/editor/publish.mdx | 124 ++++---- es/editor/review.mdx | 131 +++++++++ es/editor/settings.mdx | 201 +++++-------- es/editor/suggestions.mdx | 57 ---- es/reference/concepts.mdx | 2 +- es/reference/glossary.mdx | 2 +- fr.json | 11 +- fr/changelog.mdx | 10 +- fr/cli/index.mdx | 1 + fr/cli/install.mdx | 12 +- fr/cli/mdx-extension.mdx | 169 +++++++++++ fr/cli/preview.mdx | 4 + fr/deploy/authentication-setup.mdx | 2 +- fr/editor/agent.mdx | 70 ++--- fr/editor/branching-and-publishing.mdx | 264 ----------------- fr/editor/collaborate.mdx | 82 ++++++ fr/editor/comments.mdx | 108 ------- fr/editor/configurations.mdx | 274 ------------------ fr/editor/git-essentials.mdx | 84 ------ fr/editor/index.mdx | 124 ++++---- fr/editor/keyboard-shortcuts.mdx | 50 ++-- fr/editor/live-preview.mdx | 69 ----- fr/editor/media.mdx | 100 ------- fr/editor/navigation.mdx | 49 ---- fr/editor/pages.mdx | 242 +++------------- fr/editor/publish.mdx | 124 ++++---- fr/editor/review.mdx | 131 +++++++++ fr/editor/settings.mdx | 201 +++++-------- fr/editor/suggestions.mdx | 57 ---- fr/reference/concepts.mdx | 2 +- fr/reference/glossary.mdx | 2 +- images/editor/editor-layout-dark.png | Bin 93361 -> 0 bytes images/editor/editor-layout-light.png | Bin 92839 -> 0 bytes images/editor/layout-dark.png | Bin 0 -> 146893 bytes images/editor/layout-light.png | Bin 0 -> 145469 bytes images/editor/live-preview-dark.png | Bin 21157 -> 0 bytes images/editor/live-preview-light.png | Bin 21326 -> 0 bytes images/editor/preview-url-dark.png | Bin 45757 -> 0 bytes images/editor/preview-url-light.png | Bin 47072 -> 0 bytes redirects.json | 140 ++++++++- reference/concepts.mdx | 2 +- reference/glossary.mdx | 2 +- zh.json | 11 +- zh/changelog.mdx | 8 +- zh/cli/index.mdx | 1 + zh/cli/install.mdx | 12 +- zh/cli/mdx-extension.mdx | 169 +++++++++++ zh/cli/preview.mdx | 4 + zh/deploy/authentication-setup.mdx | 2 +- zh/editor/agent.mdx | 120 ++++---- zh/editor/branching-and-publishing.mdx | 224 -------------- zh/editor/collaborate.mdx | 129 +++------ zh/editor/comments.mdx | 108 ------- zh/editor/configurations.mdx | 168 ----------- zh/editor/git-essentials.mdx | 75 ----- zh/editor/index.mdx | 114 +++++--- zh/editor/keyboard-shortcuts.mdx | 115 +++++--- zh/editor/live-preview.mdx | 61 ---- zh/editor/media.mdx | 100 ------- zh/editor/navigation.mdx | 49 ---- zh/editor/pages.mdx | 190 +++--------- zh/editor/publish.mdx | 133 ++++----- zh/editor/review.mdx | 131 +++++++++ zh/editor/settings.mdx | 196 +++++-------- zh/editor/suggestions.mdx | 57 ---- zh/reference/concepts.mdx | 2 +- zh/reference/glossary.mdx | 2 +- 105 files changed, 2698 insertions(+), 5573 deletions(-) delete mode 100644 editor/branching-and-publishing.mdx create mode 100644 editor/collaborate.mdx delete mode 100644 editor/comments.mdx delete mode 100644 editor/configurations.mdx delete mode 100644 editor/git-essentials.mdx delete mode 100644 editor/live-preview.mdx delete mode 100644 editor/navigation.mdx create mode 100644 editor/publish.mdx create mode 100644 editor/review.mdx delete mode 100644 editor/suggestions.mdx create mode 100644 es/cli/mdx-extension.mdx delete mode 100644 es/editor/branching-and-publishing.mdx create mode 100644 es/editor/collaborate.mdx delete mode 100644 es/editor/comments.mdx delete mode 100644 es/editor/configurations.mdx delete mode 100644 es/editor/git-essentials.mdx delete mode 100644 es/editor/live-preview.mdx delete mode 100644 es/editor/media.mdx delete mode 100644 es/editor/navigation.mdx create mode 100644 es/editor/review.mdx delete mode 100644 es/editor/suggestions.mdx create mode 100644 fr/cli/mdx-extension.mdx delete mode 100644 fr/editor/branching-and-publishing.mdx create mode 100644 fr/editor/collaborate.mdx delete mode 100644 fr/editor/comments.mdx delete mode 100644 fr/editor/configurations.mdx delete mode 100644 fr/editor/git-essentials.mdx delete mode 100644 fr/editor/live-preview.mdx delete mode 100644 fr/editor/media.mdx delete mode 100644 fr/editor/navigation.mdx create mode 100644 fr/editor/review.mdx delete mode 100644 fr/editor/suggestions.mdx delete mode 100644 images/editor/editor-layout-dark.png delete mode 100644 images/editor/editor-layout-light.png create mode 100644 images/editor/layout-dark.png create mode 100644 images/editor/layout-light.png delete mode 100644 images/editor/live-preview-dark.png delete mode 100644 images/editor/live-preview-light.png delete mode 100644 images/editor/preview-url-dark.png delete mode 100644 images/editor/preview-url-light.png create mode 100644 zh/cli/mdx-extension.mdx delete mode 100644 zh/editor/branching-and-publishing.mdx delete mode 100644 zh/editor/comments.mdx delete mode 100644 zh/editor/configurations.mdx delete mode 100644 zh/editor/git-essentials.mdx delete mode 100644 zh/editor/live-preview.mdx delete mode 100644 zh/editor/media.mdx delete mode 100644 zh/editor/navigation.mdx create mode 100644 zh/editor/review.mdx delete mode 100644 zh/editor/suggestions.mdx diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index ed010ced0..6ffd1cc18 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -32,13 +32,13 @@ Atlassian (?i)auth Auth0 authed -autocommit +autocommit(s|ed|ing)? autofocuses (?i)autogenerat(e|ed|ing)? (?i)automations? (?i)automerge (?i)autoplay -autosave(s|d)? +autosav(e|es|ed|ing) AVIF AWS axios @@ -148,6 +148,7 @@ DORA (?i)drilldown DRY DynamoDB +dotfile(s)? EasyList ECS EdDSA diff --git a/changelog.mdx b/changelog.mdx index 25f7d0da3..fb9f88d1f 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -9,8 +9,8 @@ noindex: true ## Editor and collaboration - - **Editor branches:** When you create a branch, the editor now creates a draft pull request and autosaves changes to Git. You can rename or delete branches, discard autosaved changes, and move pending changes to a new branch. The branch menu is ordered by recent activity, uses per-user branch names, and shows cleaner `Draft ` names for automatically generated branches. See [Branching and publishing](/editor/branching-and-publishing). - - **Pull requests open as drafts by default:** The editor now opens new pull requests in draft state so you can share a preview URL without signaling that the change is ready to merge. Change this on the [editor settings](/editor/settings#create-pull-requests-as-drafts-by-default) page. + - **Editor branches:** When you create a branch, the editor now creates a draft pull request and autosaves changes to Git. You can rename or delete branches, discard autosaved changes, and move pending changes to a new branch. The branch menu is ordered by recent activity, uses per-user branch names, and shows cleaner `Draft ` names for automatically generated branches. See [Branching and publishing](/editor/publish). + - **Pull requests open as drafts by default:** The editor now opens new pull requests in draft state so you can share a preview URL without signaling that the change is ready to merge. Change this on the [editor settings](/editor/settings#create-draft-pull-requests-by-default) page. - **GitLab merge requests:** Merge requests opened in GitLab now sync into editor branches, matching the existing GitHub behavior. - **Streamlined editor navigation:** The editor has a new breadcrumbs row, consolidated page and share controls, sticky sidebar section headers, and a dedicated bottom bar for settings and **Ask agent**. Site settings open as editor pages instead of a modal. Mobile navigation now uses a simplified top bar and panel-based sidebar for smaller screens. - **Page access and comments:** Request edit access to a private or protected page from the editor and review requests in an approval modal. Comment cards now show profile pictures, and @mentions link to the mentioned user. @@ -111,7 +111,7 @@ noindex: true - **Faster live previews:** Live previews load much faster on first open, new pages and `docs.json` changes appear sooner, and CSS and theme edits now update in real time. - **Live preview in the editor:** Live previews open in an editor pane instead of a new tab, and site settings and the editor agent are available while you preview. - - **Authenticated live previews:** Preview drafts of pages behind authentication from the editor [live preview](/editor/live-preview). + - **Authenticated live previews:** Preview drafts of pages behind authentication from the editor [live preview](/editor/review#live-preview). - **OpenAPI 3.1 file uploads:** The API playground now recognizes OpenAPI 3.1 files uploaded to `FileInput` fields, and file inputs support drag-and-drop. See [OpenAPI setup](/api-playground/openapi-setup) for more information. - **Markdown mode:** Use the `/` menu in Markdown mode, copy content as Markdown, and pasted Markdown in visual mode formats automatically. - **Assistant analytics:** The assistant analytics view has more context and filtering than the previous version. @@ -199,7 +199,7 @@ noindex: true ## Editor and collaboration - **Review flow:** Request review on a draft, leave feedback, and approve or request changes before publishing. Reviews now support non-deploy branches. - - **More ways to collaborate:** Start [comment threads](/editor/comments) on an entire page, mention yourself to leave a reminder, and use keyboard shortcuts Option + C or Option + S to comment on or suggest changes to selected text. + - **More ways to collaborate:** Start [comment threads](/editor/collaborate#comments) on an entire page, mention yourself to leave a reminder, and use keyboard shortcuts Option + C or Option + S to comment on or suggest changes to selected text. - **Faster, more available editing:** The editor renders without waiting for the Git file tree and people without GitHub write access can use the editor. ## Automations, integrations, and Slack @@ -918,7 +918,7 @@ noindex: true - Redesigned the editor configuration settings page with an improved layout and autosave support. - Pages auto-generated from OpenAPI specifications now appear in the web editor as read-only entries. - - Video support in [live preview](/editor/live-preview). Embedded mp4, webm, and mov files now render correctly during local development. + - Video support in [live preview](/editor/review#live-preview). Embedded mp4, webm, and mov files now render correctly during local development. - [Automations](/automations) can now be disabled and re-enabled from the dashboard. - Assistant analytics now show usage broken down by source (web vs API) in the dashboard. - Authenticated MCP search now correctly filters results based on the user's authentication groups. @@ -1412,8 +1412,8 @@ noindex: true ## Web editor improvements - - Added [shareable preview links](/editor/branching-and-publishing#access-and-share-a-preview) from the editor toolbar. - - Updated [publishing workflow](/editor/branching-and-publishing) to support one-click publishing or creating pull requests. + - Added [shareable preview links](/editor/review#preview-deployments) from the editor toolbar. + - Updated [publishing workflow](/editor/publish) to support one-click publishing or creating pull requests. - Working in the web editor no longer requires you to sign in with GitHub. ## Onboarding improvements diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index bf460f857..0e5b9eaea 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -518,4 +518,4 @@ Some features behave differently or are unavailable when you enable authenticati | [skill.md](/ai/skillmd) | Full support | Not supported | Not supported | | [Sitemap](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication, but excludes pages in groups | Available behind authentication, but excludes pages in groups | | [robots.txt](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication | Available behind authentication | -| [Live preview](/editor/live-preview) | Full support | Supported for Mintlify authentication | Supported for Mintlify authentication | +| [Live preview](/editor/review#live-preview) | Full support | Supported for Mintlify authentication | Supported for Mintlify authentication | diff --git a/docs.json b/docs.json index a917458ea..43fedbdc4 100644 --- a/docs.json +++ b/docs.json @@ -122,15 +122,11 @@ "root": "editor/index", "pages": [ "editor/tutorial", - "editor/git-essentials", "editor/pages", - "editor/navigation", - "editor/live-preview", - "editor/branching-and-publishing", - "editor/comments", - "editor/suggestions", + "editor/publish", + "editor/review", + "editor/collaborate", "editor/agent", - "editor/configurations", "editor/settings", "editor/keyboard-shortcuts" ] diff --git a/editor/agent.mdx b/editor/agent.mdx index 3ac724e3b..a6d63b71e 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -10,17 +10,9 @@ The editor agent makes changes directly in your current branch. ## Open the agent -{/* vale Mintlify.FirstPerson = NO */} Click **Ask agent** in the editor toolbar, or press Cmd + I (macOS) or Ctrl + I (Windows). -To close the panel, click the **X** button in the panel header or press Cmd + I again. -{/* vale Mintlify.FirstPerson = YES */} - -## Send a message - -Type your request in the chat box at the bottom of the panel and press Enter or click the send button. - -Type @ to mention a specific page. The agent focuses on that page when processing your request. If you don't mention a page, the agent uses the page you currently have open. +Type @ to mention a specific page, and the agent focuses on it. Without a mention, it uses the page you currently have open. Example prompts: @@ -45,14 +37,14 @@ Mintlify strips scripts and other active content from SVG files before the agent ## Add a selection to the agent -In visual mode, select text on a page. A floating toolbar appears over the selection. Click **Add to agent** to send the selected text to the agent as context. +In visual mode, select text and click **Add to agent** in the floating toolbar to send it to the agent as context. ## Ask for comments and suggestions The agent edits content directly by default. To get feedback without immediately changing the page, explicitly ask the agent to review the page, leave comments, or make suggestions. -- [Suggestions](/editor/suggestions) propose a specific replacement that you can accept or reject. The original text remains visible with a strikethrough until you decide, and the agent can include an explanation in the suggestion thread. -- [Comments](/editor/comments) leave feedback or a question anchored to specific text without changing the page. +- [Suggestions](/editor/collaborate#suggestions) propose a specific replacement that you can accept or reject. The original text remains visible with a strikethrough until you decide, and the agent can include an explanation in the suggestion thread. +- [Comments](/editor/collaborate#comments) leave feedback or a question anchored to specific text without changing the page. Example prompts: @@ -64,7 +56,7 @@ The agent uses the page you currently have open unless you name another page. It ## Review what the agent changed -As the agent edits your pages, a **Changed files** panel appears in the chat. Expand it to see a list of every file modified in the session. Click any file to open it in diff view and compare the agent's changes against the original. +A **Changed files** panel appears in the chat as the agent works. Expand it to see every file modified in the session, and click any file to compare the changes against the original in diff view. ## What the agent can do diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx deleted file mode 100644 index 646aef551..000000000 --- a/editor/branching-and-publishing.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: "Branching and publishing" -description: "Understand how branches and protection rules determine what happens when you publish, and how to manage the full review and deployment workflow." -keywords: ["editor", "branch", "publish", "pull request", "preview", "git", "merge", "deploy"] ---- - -The web editor autosaves everything as you type, but your changes are only live when you choose to publish them. - -What happens when you publish depends on two things: **which branch you're on** and **whether that branch requires pull requests**. - -## Saving versus publishing - -**Saving** happens automatically. Mintlify stores your edits on its servers and persists them across browser tabs, devices, and network interruptions. - -**Publishing** commits your changes to your Git repository. Click **Publish** in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request. - -The editor tracks the following as pending changes: - -- Content edits in pages -- New or deleted pages -- Navigation structure changes -- Media uploads -- Configuration updates - -## What happens when you publish - -The actions available when you click the publish button depend on your current branch and whether it has branch protection rules that require pull requests. - -| Branch type | Branch protection | Available actions | -| --- | --- | --- | -| Deployment branch | None | **Publish** directly to your live site | -| Deployment branch | Pull requests required | **Create branch** to move changes to a new branch | -| Feature branch | None | **Save in branch**, **Create pull request** | -| Feature branch | Pull requests required | **Save in branch**, **Create pull request** | - -- **Publish**: Commits and deploys your changes to your live site immediately. -- **Save in branch**: Commits your changes to the feature branch without merging to your deployment branch. -- **Create branch**: Moves your pending changes to a new feature branch when you're on a protected deployment branch. -- **Create pull request**: Opens a pull request targeting your deployment branch. - -If there are no pending changes, the editor disables the publish and save actions. - - - Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your [dashboard](https://app.mintlify.com). - - -## When to use a branch - -**Edit directly on your deployment branch** if you do not use a Git-based workflow. - -**Create a branch** when you use a branch-based workflow where you make each change to your content on a separate branch. - -## Create and switch branches - -### Create a branch - -1. Click the branch name in the editor toolbar. -2. Click **Create new branch**. -3. If you have pending changes, choose whether to bring them to the new branch or leave them on the current branch. -4. Enter a name and click **Create branch**. - - - Use descriptive branch names so you can identify them and other people understand what each branch is for. - - -### Switch branches - -1. Click the branch name in the toolbar. -2. Search for or scroll to the branch you want. -3. Click the branch to switch to it. - - - Switching branches while you have unpublished changes prompts you to bring those changes to the new branch or leave them behind. Changes left behind remain on your original branch. - - - - To copy a branch name, hover over the branch in the dropdown and click the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request. - - -## Preview your changes - -Every time you save changes to a feature branch, Mintlify builds a preview deployment, a temporary URL where your changes render exactly as they look when published. - -### Access and share a preview - -1. Click **Publish** in the editor toolbar. -2. In the publish menu, click the preview URL. The URL format is `organization-branch-name.mintlify.site`. - - Preview URL emphasized in the publish menu. - Preview URL emphasized in the publish menu. - - -Copy the URL and send it to reviewers. The preview updates automatically each time you save to the branch. - -### Restrict access to previews - -Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication in the [Add-ons](https://app.mintlify.com/products/addons) page of your dashboard. - -### Share editor links - -To invite a teammate to a specific page on a branch, copy the URL from your browser's address bar and share it. Anyone with access to your Mintlify organization can open the link directly in their editor session. - -The URL format is: - -```text -https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} -``` - -For example: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` - -## Review and merge pull requests - -When a pull request is open for the current branch, the publish menu shows a review panel with: - -- The pull request title, description, and whether it is a draft. -- The source and target branches. -- The number of changed files. -- The approval requirement on the deployment branch: **Approval required**, **Code owner required**, or no requirement. -- The current review status: **Approved**, **Changes requested**, or **Awaiting review**. - -Click the pull request link to open it in GitHub, GitLab, or Bitbucket. - -After a reviewer approves a pull request, click **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging. - -### Approve pull requests from the editor - -For GitHub repositories, reviewers can approve open pull requests in the editor. When a pull request is open, an **Approve pull request** button appears in the review panel if your account has permission to review it. Click **Approve pull request** when the changes are ready to merge. The review status updates to **Approved** and the **Merge and publish** action becomes available. - -If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it. - - - Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub help or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab help. - - -### Review changes before merging - -Click any changed file in the publish menu to open it in diff view and compare your branch against the published version. In visual mode you see a visual diff. In source mode you see a text diff. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable. - -The file tree highlights changed pages so you can see at a glance which files an [automation](/automations) or teammate touched. Unlisted pages that appear in the branch diff are also openable from the publish menu, even though they don't appear in your site navigation. - -### Open an automation run in the editor - -When an [automation](/automations) opens a pull request, you can jump straight from the run review UI or its Slack notification into the editor on the automation's branch: - -- From the **Automation Runs** page in your dashboard, click **Open in editor** on a completed run. -- From a Slack notification, click the **View changes** link. - -Either entry point opens the editor on the automation's branch with the changed pages preselected in the publish menu. You can review the diff and merge or request changes without leaving the editor. - -### Simultaneous publishing - -Only one publish can happen at a time per branch. If another team member publishes to the same branch, wait for the current publish to complete before trying again. - -### Pull request titles and descriptions - -If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor uses a default message that lists the files you created, updated, moved, or deleted. - -## Resolve conflicts - -Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. For example, when you and a teammate edited the same lines in a file or moved a file to different locations. - -The editor displays a warning when conflicts block publishing. Follow the prompts to choose which version of each conflicting section to keep. - -## Collaborate in real time - -When multiple people open the same page on the same branch, they edit together in real time. Each person's cursor and edits are visible to everyone, with avatars shown in the toolbar. - -- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts. -- Undo only affects your own edits. -- If you lose your connection, edits save locally and sync when you reconnect. - -When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears in the editor like any other collaborator. You see the agent's avatar in the toolbar and a live cursor at its most recent edit location. The cursor clears automatically after the agent finishes. - -## Git sync - -When someone pushes changes to your repository from outside the editor, the editor incorporates those changes automatically. - -Non-overlapping changes apply automatically. If a remote change and your local edit affect the same part of a page, the editor highlights the conflict so you can resolve it. - -## Commit signing - -Sign commits with your GitHub account by authorizing it in your [account settings](https://app.mintlify.com/settings/account). Without authorization, the Mintlify GitHub App signs commits made in the web editor. - -For a reference of how editor actions map to Git operations, see [Git essentials](/editor/git-essentials#how-the-editor-maps-to-git). diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx new file mode 100644 index 000000000..a5fa67588 --- /dev/null +++ b/editor/collaborate.mdx @@ -0,0 +1,66 @@ +--- +title: "Collaborate in the editor" +sidebarTitle: "Collaborate" +description: "Leave comments, propose changes as suggestions, and edit alongside teammates in real time in the editor." +keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] +--- + +Work with your team on a page by commenting on it, suggesting changes to it, or editing it together at the same time. + +## Comments + +Comments let you leave feedback on specific text without editing the content. + +**Comments never reach your repository.** They live only inside the editor and are never included in the published site or committed to Git. + +To add a comment, highlight text and click the **Comment** icon in the toolbar. To reply, click the highlighted text or the thread in the comment sidebar. + + + The comment button in the floating toolbar above selected text in the editor. + The comment button in the floating toolbar above selected text in the editor. + + +All [roles](/dashboard/roles) can comment and reply, including viewers. Only editors and admins can resolve threads. Resolving a thread removes it from the sidebar and clears the highlight from the page. + +You can delete your own comments and admins can delete any comment. Deleting the first comment in a thread deletes the entire thread. + +Type `@` to mention a teammate. They must be a member of your organization and they receive an email notification. + +If your branch has an open pull request, Mintlify adds a summary of unresolved threads to the pull request description, with a link back to each comment. The summary updates as threads change. + +## Suggestions + +Suggestions propose a change while leaving the current content in place, so a teammate can accept or reject it. + +Editors and admins can accept or reject any suggestion. Viewers cannot. + +To make a suggestion, highlight text and click the **Switch to Suggesting** button in the toolbar. In suggesting mode, your deletions and insertions appear as highlighted text rather than edits. Pending suggestions appear in the sidebar alongside comments. + + + [Viewers](/dashboard/roles) are always in suggesting mode. Suggesting mode activates automatically when a viewer opens the editor so that they can propose changes without editing content directly. + + +Click a highlighted suggestion to accept or reject it. Either choice resolves and deletes the suggestion thread. An accepted change becomes part of your current branch and goes live the next time you [publish](/editor/publish). + +## Ask the Mintlify agent + +Mention `@mintlify` in a comment, suggestion, or reply to ask the [editor agent](/editor/agent) about the current page. The agent runs in the background with the page, thread, and branch as context, then posts its answer as a reply in the same thread. + +```text +@mintlify does this endpoint support pagination? +@mintlify are there any pages that contradict this? +``` + +The agent runs read-only when replying to comments. It can search your docs, read pages, fetch web content, and load skills, but it cannot edit content, create suggestions, or publish. To make changes, open the [editor agent](/editor/agent) directly. + +Mentions work on private pages for members who already have access. Each reply counts toward your editor agent usage. + +## Real-time editing + +When multiple people open the same page on the same branch, they edit together. Each person's cursor and edits are visible to everyone, with avatars in the toolbar. + +- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts. +- Undo only affects your own edits. +- If you lose your connection, edits save locally and sync when you reconnect. + +When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears like any other collaborator, with an avatar and a live cursor at its most recent edit. The cursor clears when the agent finishes. diff --git a/editor/comments.mdx b/editor/comments.mdx deleted file mode 100644 index 8db8f5b98..000000000 --- a/editor/comments.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Comment on pages in the editor" -sidebarTitle: "Comments" -description: "Leave inline comments on pages in the editor to give feedback, ask questions, mention teammates, and resolve threads before you publish changes." -keywords: ["editor", "comments", "collaboration", "feedback", "mentions", "threads"] ---- - -Comments let you and your team leave feedback on specific text in a page without editing the content. Use comments to ask questions, flag issues, or discuss changes before you publish them. - -Comments live only inside the editor. They are never included in the published site or committed to your repository. - -All [roles](/dashboard/roles)—viewers, editors, and admins—can leave and reply to comments. Only editors and admins can resolve comment threads. - -If your branch has an open pull request, Mintlify adds a summary of unresolved comment threads to the pull request description. The summary lists the files with open comments, the first comment in each thread, and a link to navigate to the comment in the editor. - -The summary updates when you add, resolve, or delete a comment. - -## Add a comment - -1. Highlight the text you want to comment on. -2. Click the **Comment** icon in the toolbar. -3. Type your comment and press Enter to submit. - - - The comment button in the floating toolbar above selected text in the web editor. - The comment button in the floating toolbar above selected text in the web editor. - - -## Reply to a comment - -To open a comment thread, click the highlighted text or click the thread in the comment sidebar. Type your reply and press Enter to submit. - - - A comment thread opened in the web editor and two comment threads in the sidebar. - A comment thread opened in the web editor and two comment threads in the sidebar. - - -## Mention a teammate - -Type `@` in a comment or reply to mention a teammate. People must be a member of your organization for you to mention them. - -Mentioned teammates receive an email notification. - -## Ask the Mintlify agent - -Mention `@mintlify` in a comment, [suggestion](/editor/suggestions), or reply to ask the [editor agent](/editor/agent) a question about the current page. The agent runs asynchronously with the page, thread, and branch as context, then posts its answer as a new reply in the same thread. - -Use `@mintlify` mentions to ask questions like: - -- `@mintlify does this endpoint support pagination?` -- `@mintlify is this the recommended way to configure webhooks?` -- `@mintlify are there any pages that contradict this?` - -The agent runs in read-only mode when replying to comments. It can search your docs, read pages, fetch web content, and load skills, but it cannot edit content, create suggestions, or publish changes. To make changes, open the [editor agent](/editor/agent) directly. - -`@mintlify` mentions work on private pages for members who already have access. Each agent reply counts toward your editor agent usage. - -## Resolve a comment - -Editors and admins can resolve threads when a discussion is complete. - -Click the checkmark icon to resolve a thread. Resolving a thread removes it from the comment sidebar and clears the highlight from the page. - - - A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. - A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. - - -## Delete a comment - -Click the trashcan icon beside a comment to delete it. Deleting the first comment in a thread deletes the entire thread. - -You can delete your own comments. Admins can delete any comment. diff --git a/editor/configurations.mdx b/editor/configurations.mdx deleted file mode 100644 index 5b3c41c3b..000000000 --- a/editor/configurations.mdx +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: "Configurations" -description: "Edit site branding, appearance, navigation, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." -keywords: ["editor", "configurations", "settings", "branding", "theme"] -boost: 3 ---- - -Configure your site's branding, appearance, and features from the **Site configurations** panel in the web editor. Configuration changes sync in real time with other editors on the same branch, so your team always sees the latest settings. - -To open the panel, click the configurations icon in the editor toolbar. - - - Configurations menu in the editor. - Configurations menu in the editor. - - -The panel groups settings into sections that map to the top-level properties in your [`docs.json`](/organize/settings). - -## General - -Set your site's identity and how it appears to visitors. - -- **Name**: The name of your project. Appears in browser tabs and search results. -- **Description**: Brief overview of your project. Used for SEO and answer engine optimization (AEO). - -## Branding - -Upload the marks that identify your site. - -- **Logo**: Your brand logo. Upload PNG or JPG files. Set separate light and dark versions and an optional click-through URL. To use an SVG logo, add the file to your repository and reference its path in your [`docs.json`](/organize/settings-appearance#logos). -- **Favicon**: Small icon that appears in browser tabs. Upload ICO, PNG, GIF, or JPG files. Set separate light and dark versions if needed. - -## Styling - -Control your site's visual identity and color scheme. - -- **Theme**: Choose a [theme](/customize/themes) for your site's overall appearance. -- **Primary color**: The main accent color used throughout your site for links, buttons, and highlights. -- **Light color**: Accent color used in dark mode. How themes apply this varies by theme. -- **Dark color**: Accent color used in light mode. How themes apply this varies by theme. -- **Background color**: Custom background colors for light and dark modes. -- **Icon library**: Icon library used for all icon properties. Defaults to `fontawesome`. -- **Strict appearance**: Lock the site to a single appearance mode and hide the theme toggle. -- **Default appearance**: Whether your site loads in `system`, `light`, or `dark` mode by default. -- **Background decoration**: Apply a visual style (`gradient`, `grid`, or `windows`) to your background. -- **Background image**: Optional background image. Set a single image or separate light and dark versions. - -## Typography - -Replace default fonts with your brand's typography. - -- **Font family**: Any [Google Fonts](https://fonts.google.com/) family works out of the box. For a self-hosted font, provide a source URL and format (`woff` or `woff2`). -- **Weight**: Typically `400` for regular and `700` for bold. Variable fonts support precise weights like `550`. -- **Heading font**: Optional override applied to all headings (`h1` through `h6`). -- **Body font**: Optional override applied to body text and the remainder of the page. - -## Navbar - -Add navigation elements to the top of your site. - -- **Primary button**: The main call-to-action in your header. Set the type, label, and destination URL. -- **Navbar links**: Additional navigation links in your header. Each link includes text and a URL. - -## Footer - -Add links and social media handles to your site footer. - -- **Social links**: Profiles on platforms like GitHub, X, LinkedIn, Discord, YouTube, and Slack. -- **Footer columns**: Enable to organize footer links into up to four columns with custom headings. - -## Banner - -Display an announcement bar across the top of every page. - -- **Content**: The banner text. Supports basic MDX formatting like links, bold, and italic. Custom components are not supported. -- **Dismissible**: Show a dismiss button on the right side of the banner. -- **Type**: Visual style. `info` uses the primary brand color, `warning` uses an amber background, and `critical` uses a red background. Defaults to `info`. -- **Color**: Override the banner background color with a custom hex color. Set separate light and dark values for theme-aware colors. - -## Thumbnail - -Customize page thumbnails and social previews. - -- **Background**: Custom background image for thumbnails. -- **Appearance**: Render thumbnails in `light` or `dark` mode. When unset, thumbnails are auto-generated from your theme colors. -- **Font**: Custom font for text in thumbnails. - -## Content - -Customize how content appears on your site. - -- **Page eyebrow**: Show small labels preceding page titles. Choose `section` or `breadcrumbs`. -- **Timestamps**: Show the date the content was last modified on all pages. -- **LaTeX**: Load LaTeX (KaTeX) stylesheets for mathematical notation rendering. - -## Code blocks - -Configure syntax highlighting and code block behavior. - -- **Code block theme**: Match the site light/dark mode with `system`, always use a dark theme with `dark`, or pick a custom [Shiki](https://shiki.style/) theme. -- **Custom code languages**: Register additional syntax highlighting languages. - -## Context menu - -Configure the quick actions surfaced in the page context menu. - -- **Options**: Multi-select dropdown of actions like `copy`, `view`, and opening the page in `chatgpt`, `claude`, `cursor`, and other AI assistants. -- **Display**: Where to display the options. `header` (default) shows them in the top-of-page context menu; `toc` shows them in the table of contents sidebar. - -## Navigation - -Tune navigation behavior across your site. - -- **Drilldown**: Auto-navigate to the first page when a user clicks a navigation group. - -## Search - -Customize the search experience and feedback. - -- **Search placeholder**: The text that appears in the search box before users type. Default is `Search or ask`. -- **Feedback**: Show thumbs-up and thumbs-down buttons or a "Suggest edits" link on every page. - -## API reference - -Document your API endpoints. - -- **OpenAPI specs**: Add OpenAPI specification files to generate API reference pages. -- **AsyncAPI specs**: Add AsyncAPI specification files to generate API reference pages. -- **MDX server**: Custom MDX server endpoints for the API playground. -- **Playground display**: Show the interactive API playground, the simple API playground, or no API playground. -- **Proxy server**: Enable or disable the proxy server for API requests. -- **MDX schema**: Whether to render the schema section on API reference pages. - -## Redirects - -Use the **Redirects** section to add, edit, search, and remove redirects without manually editing your `docs.json` file. Redirects send users from old URLs to new ones, which is useful when you rename pages or restructure your site. For more information, see [Redirects](/create/redirects). - -Each redirect has the following fields: - -- **Source**: The path to redirect from, like `/old-path`. Supports wildcards. -- **Destination**: The path to redirect to, like `/new-path`. Supports wildcards. -- **Status**: The HTTP status code for the redirect. - - `308`: Permanent redirect. Use this for content that has moved permanently. This is the default status. - - `307`: Temporary redirect. Use this when the move is temporary. - - - Redirects menu in the editor. - Redirects menu in the editor. - - -To add a redirect: - -1. Click **Add redirect**. -2. Enter the source and destination. -3. Click **Save**. - -To edit or remove an existing redirect, hover over the row and use the inline edit icon or the **X** to remove it. - -## SEO - -Configure metatags and indexing for search engines. - -- **Metatags**: Custom `` tags applied across your site. Add key-value pairs for tags like `og:image` or `twitter:card`. -- **Indexing**: Choose whether to index hidden pages. - -## Analytics - -Connect analytics platforms to track visitor behavior. Supported providers include Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit, and more. - -Each entry renders as an inline row. Use the **X** icon to remove an integration. - -## 404 page - -Customize the experience when a user lands on a missing page. - -- **Redirect to home**: When on, missing pages redirect to your home page. When off, the site shows a 404 page and you can customize the title and description below. -- **Title**: Heading shown on the 404 page. -- **Description**: Subheading shown on the 404 page. - -## Variables - -Define custom variables that can be re-used throughout your content. Each variable is a key-value pair. Use the **X** icon to remove a variable. diff --git a/editor/git-essentials.mdx b/editor/git-essentials.mdx deleted file mode 100644 index b4e809642..000000000 --- a/editor/git-essentials.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "Git essentials for the editor" -sidebarTitle: "Git essentials" -description: "Understand the Git version control concepts behind the Mintlify editor, including branches, commits, pull requests, and merge workflows." -keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"] ---- - -Git lets you control and track changes to files. It's the version control system behind branch-based workflows, where you manage content the same way you would any other codebase. - -The web editor handles Git operations for you. Understanding a few key concepts helps you get the most out of the editor and collaborate effectively with your team. - -## What Git does for your content - -Git tracks every change made to your content. It records what changed, who changed it, when they changed it, and why. This means you can: - -- See the full history of any page. -- Undo changes by reverting to a previous version. -- Work on updates without affecting your live site. -- Review changes before they go live. - -Your repository is the collection of files and their history that makes up your site. The editor connects to this repository to sync and publish your content. - -## Key concepts - -These are the Git concepts you'll encounter most often when using the web editor. - - - - A saved snapshot of your changes at a specific point in time. Each commit includes a message describing what changed and creates a permanent record in your project history. - - When you publish changes, the web editor creates a commit in your Git repository. - - - A separate line of work in your repository. Sometimes called a **feature branch**. - - Your live site builds from a **deployment branch**, usually called `main`. Other branches let you work on changes independently without affecting your live site. Nothing on a branch goes live until you merge it into your deployment branch with a pull request. - - Switch between branches using the branch dropdown in the editor toolbar. If you have unpublished changes, the editor lets you bring them to the new branch or leave them on your current branch. - - - The branch that builds your live site, typically called `main`. Changes merged into this branch automatically deploy to your site. - - - A proposal to merge changes from one branch into another. Pull requests let your team review and discuss changes before they go live. - - When you publish changes on a feature branch (or when your repository requires pull requests), the web editor creates a pull request. Your team reviews and merges the pull request in your Git provider (GitHub, GitLab, or Bitbucket). - - - Combining changes from one branch into another. After your team reviews and approves a pull request, merging the branch incorporates your changes into the deployment branch and publishes them. - - - Occurs when two branches have incompatible changes to the same files. The editor helps you resolve conflicts when they occur. - - - A comparison showing the differences between two versions of a file. The editor shows a visual diff of your pending changes before you publish so you can review exactly what gets committed. - - - -## How the editor maps to Git - -Every action in the web editor corresponds to a Git operation. Here is the full reference: - -| Action in the editor | Git operation | -|---|---| -| Edit a page | Changes auto-save to Mintlify servers. No Git commit yet. | -| Publish on your deployment branch | `git commit` and `git push`. Triggers a deployment. | -| Save in branch | `git commit` to the current feature branch. | -| Create pull request | `git push` and opens a pull request against your deployment branch. | -| Merge and publish | Merges the pull request and triggers a deployment. | -| Create a branch | `git checkout -b ` | -| Switch branches | `git checkout ` | -| External push or CLI update | Incoming changes sync into the editor automatically using a three-way merge. | diff --git a/editor/index.mdx b/editor/index.mdx index 3b14a32de..bf98d3468 100644 --- a/editor/index.mdx +++ b/editor/index.mdx @@ -1,84 +1,86 @@ --- title: "Editor overview" sidebarTitle: "Overview" -description: "Create, edit, and publish content in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync." -keywords: ["editor", "visual", "collaborative", "web editor"] +description: "Create, edit, and publish content in your browser with the Mintlify editor. Supports real-time collaboration and continuous Git sync." +keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- - A step-by-step walkthrough: create a branch, make a change, share a preview, and publish. + Create a branch, make a change, share a preview, and publish. -## Open the editor +Use the editor to write and publish documentation in your browser. The editor uses a docs-as-code workflow with all your changes backed by Git. Your work saves as commits in your repository and the editor manages Git operations for you. -Open the editor from the [Editor](https://app.mintlify.com/editor) tab in your Mintlify dashboard. Any member of your organization can open the editor, but what you can do inside depends on your [role](/dashboard/roles). Admins and editors can edit and publish, and viewers can browse content and leave [comments](/editor/comments) or [suggestions](/editor/suggestions). +The editor loads by default when you open your [dashboard](https://app.mintlify.com). Anyone in your organization can open it, but certain actions depend on your [role](/dashboard/roles). Admins and editors can edit and publish. Viewers can browse content and leave [comments and suggestions](/editor/collaborate). ## How the editor works -**Changes save automatically.** As you type, the editor saves your work. Your changes persist across tabs, devices, and network interruptions. Changes only go live when you publish them. +**Changes save automatically, but saving is separate from publishing.** As you type, the editor stores your work. Your changes persist across tabs, devices, and network interruptions. For any changes to reach your live site, you must [publish](/editor/publish) them. -**Git stays in sync.** When someone else pushes changes to your repository from outside the editor, those changes appear in the editor automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and highlights anything that needs your attention. +**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. If you publish to your deployment branch, this updates your live site immediately. On a feature branch, you can choose whether publishing updates your live site immediately or opens a pull request for review. - - If the editor ever appears out of sync with your repository, use [Reset editor](/editor/settings#reset-editor) to force a resync from Git. For example, the file tree is empty or shows `Unable to find docs.json` even though the file is present on your deployment branch. - +**Git stays in sync.** When someone pushes to your repository, those changes appear automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and flags anything that needs your attention. -**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. On a deployment branch, this updates your live site immediately. On a feature branch, it creates a pull request. +**Your team edits together.** Multiple people can edit the same page at once, with live cursors showing who is working where. Comments and suggestions are visible to everyone. -**Your team edits together.** Multiple people can edit the same page simultaneously. Live cursors show who is editing and where. + + If the editor ever appears out of sync with your repository, use [Reset editor](/editor/settings#reset-editor) to force a resync. For example, an empty file tree or the error `Unable to find docs.json` appears when the file is present on your deployment branch. + -## The editor layout +## Editor layout - Screenshot of the editor showing the branch selector, ask agent button, publish button, navigation sidebar, and top bar. - Screenshot of the editor showing the branch selector, ask agent button, publish button, navigation sidebar, and top bar. + Screenshot of the editor with the Publishing tab selected. + Screenshot of the editor with the Publishing tab selected. -- **Top bar**: Use the top bar to control what branch you work on, access the agent, preview, and publish changes. -- **Navigation sidebar**: Select a page to edit, create new pages, and manage the site structure. - -## Explore the editor - - - How branches and protection rules determine what happens when you publish, and how to manage the pull request review process. - - - - Leave feedback, ask questions, and discuss changes with your team. - - - - Propose changes that teammates can review, accept, or reject. - - - - Edit pages, search your content, modify settings, and configure your site from a chat interface. - - - - Add new and update existing pages. - - - - Reorder pages and manage site structure. - - - - Preview your site in real time as you edit without waiting for a build. - - - - Configure your site's branding, colors, and features. - - - - Configure AI instructions and publishing defaults for your deployment. - - - - Understand the Git concepts behind the editor: branches, commits, pull requests, and merges. - - - - Save time with keyboard shortcuts. - +* **Top bar**: Use the top bar to control what branch you work on, access the agent, preview, and publish changes. +* **Sidebar**: Use the sidebar to select pages to edit, create new pages, and manage your site structure. + * **Home**: The file tree for your project. Pages in **Personal** are private to you. Pages in **Workspace** are public to your organization. + * **Publishing**: The navigation structure for your site. Organize pages as you want them to appear in your site. + +## Visual and source mode + +**Visual mode** renders your page as you type. Press / to open the component menu and insert components. + +**Source mode** gives you direct access to the MDX. Use it for precise control over component properties and frontmatter. + +Both modes edit the same file. Switch between them with Cmd + Shift + S (macOS) or Ctrl + Shift + S (Windows). + +For the components you can insert, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code). + +## Git concepts + +Understanding some Git concepts helps you get the most from the editor. + + + + A saved snapshot of your changes at a point in time, with a message describing what changed. Publishing creates a commit. + + + A separate line of work. Your live site builds from a **deployment branch**, usually `main`. Other branches—sometimes called **feature branches**—let you work without affecting your live site. Nothing on a feature branch goes live until you merge it. + + + A proposal to merge one branch into another, so your team can review changes before they go live. Your team reviews and merges pull requests in GitHub, GitLab, or Bitbucket, or [from the editor](/editor/review). + + + Combining changes from one branch into another. Merging into your deployment branch publishes those changes. + + + Two branches with incompatible changes to the same lines. The editor prompts you to choose which version to keep in order to resolve conflicts before merging. + + + A comparison between two versions of a file. The editor shows a diff of your pending changes before you publish. + + + +| Action in the editor | Git operation | +|---|---| +| Edit a page | Saves automatically. No commit yet. | +| Publish on your deployment branch | `git commit` and `git push`. Triggers a deployment. | +| Save in branch | `git commit` to the current feature branch. | +| Create pull request | `git push` and opens a pull request against your deployment branch. | +| Merge and publish | Merges the pull request and triggers a deployment. | +| Create a branch | `git checkout -b ` | +| Switch branches | `git checkout ` | +| External push or CLI update | Incoming changes sync into the editor using a three-way merge. | diff --git a/editor/keyboard-shortcuts.mdx b/editor/keyboard-shortcuts.mdx index f5dcf76f5..4d05cb5ff 100644 --- a/editor/keyboard-shortcuts.mdx +++ b/editor/keyboard-shortcuts.mdx @@ -15,9 +15,7 @@ These shortcuts work regardless of which mode you're in. | **Search files and content** | Cmd + K | Ctrl + K | | **Toggle AI assistant** (when not editing text) | Cmd + I | Ctrl + I | | **Switch between visual and source mode** | Cmd + Shift + S | Ctrl + Shift + S | -| **Toggle diff view** | Cmd + Shift + D | Ctrl + Shift + D | -| **Switch between Navigation and Files tree** | Cmd + Shift + F | Ctrl + Shift + F | -| **Hide/show sidebar** | Cmd + \\ | Ctrl + \\ | +| **Show all files** (including dotfiles and non-content files) | Cmd + Shift + . | Ctrl + Shift + . | ## Visual mode @@ -44,6 +42,8 @@ Use these shortcuts when editing in visual mode. | **Heading 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | | **Heading 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | | **Heading 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Heading 5** | Cmd + Option + 5 | Ctrl + Alt + 5 | +| **Heading 6** | Cmd + Option + 6 | Ctrl + Alt + 6 | ### Lists and blocks @@ -78,7 +78,7 @@ The editor automatically converts certain character sequences into typographic s ## Source mode -Source mode uses the Monaco editor, which supports standard VS Code keyboard shortcuts. +Source mode uses CodeMirror. Most common code editor shortcuts work, along with the ones below. ### Search and navigation @@ -91,7 +91,11 @@ Source mode uses the Monaco editor, which supports standard VS Code keyboard sho | Command | macOS | Windows | | :--- | :--- | :--- | +| **Bold** (wraps in `**`) | Cmd + B | Ctrl + B | +| **Italic** (wraps in `_`) | Cmd + I | Ctrl + I | | **Toggle comment** | Cmd + / | Ctrl + / | +| **Fold all** | Cmd + Option + Shift + [ | Ctrl + Alt + Shift + [ | +| **Unfold all** | Cmd + Option + Shift + ] | Ctrl + Alt + Shift + ] | | **Indent line** | Tab | Tab | | **Outdent line** | Shift + Tab | Shift + Tab | | **Move line up** | Option + | Alt + | diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx deleted file mode 100644 index 1f9edfafb..000000000 --- a/editor/live-preview.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "Live preview" -description: "Preview your site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly." -keywords: ["editor", "preview", "live preview"] ---- - -Preview your site while you edit. Live previews render pages exactly as they look when published, and update as you make changes to content, navigation, and configuration. - -## Open live preview - -Click the live preview button in the top bar. - - - The live preview button in the toolbar. - The live preview button in the toolbar. - - -## Edit site settings in live preview - -Edit your site settings in the live preview to see how they affect the rendered content. - -1. Open the live preview in the editor. -2. Click **Site settings** in the preview toolbar. -3. Select a configuration section and edit the settings. - -If you set the live preview to open in a new tab, the preview site settings menu is unavailable. Disable **Open live preview in new tab** in [editor settings](/editor/settings) to use the site settings menu. - -## Ask the agent in live preview - -Click **Ask agent** in the preview toolbar to open the [editor agent](/editor/agent) beside the live preview. Only editors and admins can use the agent in live previews. - - - Live preview works for public sites and sites protected by Mintlify authentication. - - -## Live preview versus preview deployments - -| | Live preview | Preview deployment | -|---|---|---| -| **Speed** | Instant | Requires a build | -| **Access** | Local URL | Shareable URL | -| **Use when** | Reviewing changes while editing | Sharing with your team for review | -| **Availability** | While the editor is open | As long as the branch exists | - -Use live preview for immediate feedback while editing. When you need to share changes with your team or test on a different device, use a [preview deployment](/editor/branching-and-publishing#preview-your-changes). diff --git a/editor/navigation.mdx b/editor/navigation.mdx deleted file mode 100644 index 450e1bbbb..000000000 --- a/editor/navigation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Organize navigation" -description: "Reorder pages, add groups, and manage your documentation sidebar structure using drag-and-drop in the Mintlify web editor—no docs.json edits needed." -keywords: ["editor", "navigation", "sidebar", "structure"] ---- - -Use the navigation sidebar to organize your documentation. The editor syncs your changes to your repository when you publish. You don't need to edit `docs.json` manually. - -## Add navigation elements - -Click **Add new** at the bottom of the navigation tree to add a new element at the root level. To nest an element inside another, click the plus button next to that element. - -Drag and drop elements to reorder or nest them. Hover over an element and click the gear icon to configure its properties. - -Right-click a **page** to open its settings or delete it. - -Right-click a **navigation element** to open its settings or convert it to a different element type. You can also duplicate it, add a page or group inside it, ungroup it, or delete it. - - - Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The editor prevents you from creating invalid combinations. - - -## Navigation elements - -Choose the right structure for your content: - -- **Pages**—Individual documentation files. The core building block of navigation. -- **Groups**—Collapsible sections that cluster related pages together. Can nest within other groups. -- **Tabs**—Top-level sections with horizontal navigation at the top of your site. Use tabs when you have distinct areas like API Reference and Guides. -- **Anchors**—Persistent items at the top of your sidebar. Useful for quick access to external resources or top-level sections. Can be global to appear on every page. -- **Dropdowns**—Expandable menus at the top of your sidebar. A lighter alternative to tabs for multiple related sections. -- **Menus**—Dropdown navigation items within a tab for direct links to specific pages. -- **Products**—A switcher for multiple distinct product documentation sets, each with its own navigation structure. -- **Versions**—A switcher for multiple simultaneous documentation versions. -- **Languages**—A switcher for documentation in multiple languages. - -## Configure elements - -Hover over any navigation element and click the gear icon to set: - -- **Title**: The label shown in the sidebar. -- **Icon**: A visual marker next to the label. -- **Tag**: A badge like "NEW" or "BETA" to highlight the item. - diff --git a/editor/pages.mdx b/editor/pages.mdx index cd40b1fa8..9be78797f 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -1,172 +1,70 @@ --- title: "Create and edit pages" -description: "Create pages, edit content, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your content." -keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages"] +sidebarTitle: "Edit content" +description: "Create pages, edit content, add media, organize your navigation, and recover earlier versions of a page in the editor." +keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- -## Navigate files +## Home and Publishing -The left panel has two views: **Navigation** and **Files**. +The editor workspace is split into two tabs: **Home** and **Publishing**. -**Navigation** shows your sidebar structure as visitors see it. Click a page to open it. +**Home** is your workspace. It shows the content files in your repository, including your private pages, whether or not they appear on your published site. -**Files** shows the full file tree of your repository, including files that aren't in your navigation. Click any file to open it. +**Publishing** is your published site. It shows the navigation your visitors see, along with your site settings. -To switch between views, click the file icon or press Cmd + Shift + F (macOS) or Ctrl + Shift + F (Windows). To search by filename or page content, click the search icon or press Cmd + K (macOS) or Ctrl + K (Windows). +Home hides some files by default including `docs.json`, files and folders whose names start with a dot, files with no extension, all-caps Markdown files like `README.md`, and `.css`, `.js`, `.jsx`, `.mjs`, `.cjs`, and `.pdf` files. To see all files, turn on [Show all files](/editor/settings#appearance) or press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows). -## Manage files and folders +## Create a page -Use the Files view to organize your content: +To add a page to your navigation, click the plus button on the navigation element where you want it. Enter a name for your page. The editor adds the `.mdx` extension for you. -- **Create a folder**: Click the new folder button at the top of the file tree, or right-click an existing folder and select **New folder**. -- **Rename a file or folder**: Right-click the item and select **Rename**. -- **Open unlisted files**: Click any file in the tree to open it, even if it isn't included in your navigation. - -Files that aren't in your navigation remain unlisted. They exist in your repository but won't appear in the published sidebar. - -## Create new pages - -### Add a page to navigation - -1. Click the plus button in the navigation element where you want to add a page. -1. Click **Add a page**. -1. Enter a filename. The editor adds the `.mdx` extension automatically. - -### Create an unlisted page - -Unlisted pages exist in your repository but don't appear in navigation. They're useful for draft content, reusable snippets, or pages you plan to add to navigation later. - -Right-click any folder in the Files view and select **New file**. Enter a filename and the editor creates the page without adding it to navigation. You can add it to navigation later from the **Navigation** tab. - -## Edit content - -Switch between visual and source mode using the mode toggle in the toolbar below the top bar. To switch to visual mode, click the eye icon or press Cmd + Shift + S (macOS) or Ctrl + Shift + S (Windows). To switch to source mode, click the code icon or press the same shortcut. - -**Visual mode** shows a real-time preview as you type. Press / to open the component menu and insert components, images, videos, and other content. You can also drag and drop media files directly onto the page from your computer or from the navigation tree. Other shortcuts: - -- **Insert a link**: Select text and press Cmd + K (macOS) or Ctrl + K (Windows). You can also drag a page from the navigation tree into the editor to create a link with the page title. -- **Link to another page**: Right-click a page in the navigation tree, click **Copy link**, then paste the link into your content. The editor recognizes internal links to other pages and converts them. -- **Insert media from your project**: Drag an image or video from the navigation tree into the page to embed it inline. Supported formats include PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM. -- **Insert an emoji**: Type : followed by a keyword to open the emoji picker. -- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells. - -**Source mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter. - -For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code). - -### Task lists - -In visual mode, type `/task` and select **Task List** to add an interactive checklist. You can also type `- [ ]` followed by a space to turn a list item into a task. Click the checkbox beside a task to mark it complete. - -Press Enter at the end of a task to add another unchecked task. Press Enter again on an empty task to exit the list. - -In source mode, use `- [ ]` for an incomplete task or `- [x]` for a completed task. - -### Diff view - -To compare your current page against the last published version, click the **View diff** button in the toolbar, or press Cmd + Shift + D (macOS) or Ctrl + Shift + D (Windows). In visual mode, this shows a visual diff. In source mode, it shows a text diff. Click **Exit diff** or press the shortcut again to return to editing. - -You can also open a diff from the publish menu. Click **Publish** then click any changed file in the list. - -### Version history - -Use version history to review saved versions of the page you edit. Version history isn't available for `docs.json` files. - -The version history groups entries by date. Each entry shows the author and save time. The editor marks the most recent entry as **Current**. - -The editor records a new entry when content differs from the latest recorded version. If you save unchanged content, the editor doesn't create a duplicate entry. - -To open version history: - -1. Open a page in the editor. -1. Click **More options** in the top-right corner of the page. -1. Click **Version history**. - -If you enable version history for pages, you can click the **Edited** timestamp on the page to open version history. - -Public page history only includes the current branch. Private page history includes entries across branches. Click **Show more versions** to load older entries. - -Older versions include a **Restore** action when you have permission to edit the page. If you restore an older version, you overwrite any unsaved changes. Viewers can review and compare saved versions of private pages. Editors and managers can restore them. +## Add media -For public pages, the editor restores the page on your current branch. For private pages, it updates the shared private content. +Type /image or /video to upload a file or pick one already in your repository. You can also drag files from your computer onto the page. To reuse media, drag an image or video from the navigation tree onto a page. -To compare an older saved version with the current page, click its row. The editor opens diff view with the older version as the baseline and the current page content as the comparison. To exit comparison and return to editing, click the active row again. +- Uploads save to your `images/` and `videos/` folders and commit with your next publish. +- Supported formats are PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM. +- To serve different images in light and dark mode, hover an inserted image and use **Light/dark variants**. +- Type /embed and paste a YouTube, Loom, or Vimeo URL to generate the iframe. For anything else, toggle **Manual embed** to write custom HTML. -### Block actions +For formatting images and using the Frame component, see [Images and embeds](/create/image-embeds). -In visual mode, hover over any block to reveal a drag handle on the left. Click the handle to open a context menu with actions for that block: +## Organize navigation -- **Turn into**: Convert the block to a different type: text, headings, blockquote, or list. -- **Duplicate**: Insert a copy of the block immediately after it. -- **Delete**: Remove the block. +Drag elements in the Navigation view to reorder or nest them. The editor writes your changes to `docs.json` when you publish. - - The block actions menu in visual mode. - The block actions menu in visual mode. - +- **Groups**: Collapsible sections that cluster related pages. Can nest inside other groups. +- **Tabs**: Top-level sections with horizontal navigation. Use these for distinct areas like API reference and guides. +- **Anchors**: Persistent items at the top of your sidebar. Useful for external resources. Can be global, appearing on every page. +- **Dropdowns**: Expandable menus at the top of your sidebar. A lighter alternative to tabs. +- **Menus**: Dropdown items within a tab that link directly to specific pages. +- **Products**: A switcher for multiple product documentation sets, each with its own navigation. +- **Versions**: A switcher for multiple simultaneous documentation versions. +- **Languages**: A switcher for documentation in multiple languages. -### Table of contents + + Some elements can't nest inside others. Tabs can't nest inside groups, for example. The editor prevents invalid combinations. + -In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section. +To change a page's title, slug, description, or layout, open its settings from the navigation tree. See [Pages](/organize/pages) for more information on specific settings. -### Code block options +## Version history -When editing a code block in visual mode, you can: +Version history lets you review and restore earlier saved versions of a page. It isn't available for `docs.json`. -- **Highlight or focus lines**: Select text within the code block, then use the toolbar that appears to mark lines as highlighted or focused. Highlighting visually emphasizes lines. Focusing lines dims everything else. -- **Mark diff lines**: Select lines and use the toolbar to mark them as additions (`+`) or removals (`-`). -- **Wrap**: Toggle line wrapping in the code block settings. -- **Expandable**: Make the code block collapsible so readers can expand it on demand. +Viewers can review and compare saved versions of private pages. Editors and admins can restore them. -## Manage pages +The editor records a new entry whenever content differs from the latest recorded version. Version history is branch-scoped. Only the current branch's version history is available. -- **Move**: Drag and drop pages to reorder them in navigation. -- **Rename**: Right-click a page and select **Rename**. -- **Duplicate**: Right-click a page and select **Duplicate**. -- **Delete**: Right-click a page and select **Delete**. The editor removes the page from navigation automatically. +To view version history, click **More options** in the top-right of the page, then click **Version history**. -### Move private pages to the workspace +If you restore a version, it overwrites any unsaved changes you made to the page. When you restore a public page, it is only restored on your current branch. When you restore a private page, it is restored on all branches. -To turn a private page or folder into workspace content, drag the private content from the **Private** section to a folder in your workspace. You can also right-click the private content and select **Move to workspace**. +## Private pages -When you move a private folder, all pages in the folder move to your workspace. Any content you move to your workspace immediately becomes available to your workspace collaborators, but it is not added to your site navigation. +Dragging a private page or folder into your workspace makes it available to your collaborators immediately, though it is not added to your site navigation. - You can't move workspace content back to the **Private** section. + You can't move workspace content back to the **Private** section. Making a private page public is a one-way change. - -### Pages deleted via Git - -If a teammate deletes a page through Git while you have it open, the editor enters read-only mode and shows a banner. The editor preserves your content so you can copy it before navigating away. - -## Configure pages - -Hover over a page and click the gear icon, or right-click and select **Settings**, to configure: - -- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL. -- **Description** and **Keywords**: Improve search and SEO. -- **Layout**: Choose from standard, wide, centered, or custom. - -For details on each setting, see [Pages](/organize/pages). - -## Add media - -### Images and videos - -Type /image to upload a new image or select an existing one from your repository. Type /video to upload or select a video. - -You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In source mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`. - -To reuse media that already lives in your project, drag an image or video file from the navigation tree onto the page. The editor embeds the asset inline. - -### Light and dark image variants - -After inserting an image in visual mode, hover over it to reveal the image toolbar. Use **Light/dark variants** to upload separate images for light and dark mode. - -### Embed external media - -Type /embed and paste a YouTube, Loom, or Vimeo URL. The editor detects the provider and generates the iframe. Searching the slash menu for `youtube`, `yt`, `loom`, or `vimeo` also surfaces the **Embed** command. - -For other embeds, type /embed and toggle **Manual embed** to write custom HTML. - -For more on formatting images and using the Frame component, see [Images and embeds](/create/image-embeds). diff --git a/editor/publish.mdx b/editor/publish.mdx new file mode 100644 index 000000000..b287755eb --- /dev/null +++ b/editor/publish.mdx @@ -0,0 +1,72 @@ +--- +title: "Publish changes" +sidebarTitle: "Publish" +description: "Publish changes from the editor to your live site. Branches and protection rules determine what happens when you publish." +keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull request"] +--- + +Your changes save automatically as you edit, but they only reach your live site when you publish them. What happens when you publish depends on which branch you work on and whether that branch requires pull requests. + + + If you don't see a branch selector or a **Publish** button, your deployment has [auto publish](#auto-publish) turned on and your edits go live automatically. + + +## Pending changes + +The editor tracks the following as pending changes: + +- Content edits in pages +- New or deleted pages +- Navigation structure changes +- Media uploads +- Configuration updates + +If there are no pending changes, the editor disables the publish and save actions. + +## What happens when you publish + +| Branch type | Branch protection | Available actions | +| --- | --- | --- | +| Deployment branch | None | **Publish** directly to your live site | +| Deployment branch | Pull requests required | **Create branch** to move changes to a new branch | +| Feature branch | None | **Save in branch**, **Create pull request** | +| Feature branch | Pull requests required | **Save in branch**, **Create pull request** | + +- **Publish**: Commits and deploys your changes to your live site immediately. +- **Save in branch**: Commits your changes to the feature branch without merging to your deployment branch. +- **Create branch**: Moves your pending changes to a new feature branch when you're on a protected deployment branch. +- **Create pull request**: Opens a pull request targeting your deployment branch. + +Only one publish can happen at a time per branch. If a teammate publishes to the same branch, wait for their publish to complete before trying again. + + + Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your [dashboard](https://app.mintlify.com). + + +## When to use a branch + +Edit directly on your deployment branch if you do not use a Git-based workflow. Create a branch if each change goes through review before it reaches your live site. + +To create a branch, click the branch name in the editor toolbar, select **Create new branch**, enter a name, then click **Create branch**. + + + Creating or switching branches while you have unpublished changes prompts you to bring those changes with you or leave them behind. Changes you leave behind stay on the original branch. + + +## Resolve conflicts + +Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. For example, when you and a teammate edit the same lines or move a file to different locations. + +When someone pushes to your repository from outside the editor, the editor applies non-overlapping changes automatically. If a remote change and your edit affect the same part of a page, the editor highlights the conflict. + +The editor displays a warning when conflicts block publishing. Follow the prompts to choose which version of each conflicting section to keep. + +## Commit signing + +Sign commits with your GitHub account by authorizing it in your [account settings](https://app.mintlify.com/settings/account). Without authorization, the Mintlify GitHub App signs commits made in the editor. + +## Auto publish + +If your deployment has [auto publish](/editor/settings#main-branch-autocommits) turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and **Publish** button are hidden. There is no pending state and no review step. + +Edits on feature branches created from the editor commit automatically either way, but they never publish unless you merge them into your deployment branch. diff --git a/editor/review.mdx b/editor/review.mdx new file mode 100644 index 000000000..567b0c0ba --- /dev/null +++ b/editor/review.mdx @@ -0,0 +1,82 @@ +--- +title: "Review changes" +sidebarTitle: "Review" +description: "Preview changes before they go live, share them with your team, and approve and merge pull requests from the editor." +keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"] +--- + +Preview your changes before they reach your live site, then review and merge the pull request without leaving the editor. + +## Live preview + +Live preview renders your site as you edit, with no build step. Click the live preview button in the top bar. + +To edit site settings and see how they affect your content, click **Site settings** in the preview toolbar, then select a configuration section. This menu is unavailable if you have [Open live preview in new tab](/editor/settings#appearance) enabled. + +To open the [agent](/editor/agent) beside the preview, click **Ask agent** in the preview toolbar. Only editors and admins can use the agent in live previews. + + + Live preview is only available for public sites and sites protected by Mintlify authentication. + + +## Preview deployments + +When you open a pull request from a feature branch, Mintlify builds a preview deployment: a temporary URL where your changes render exactly as they look when published. The preview rebuilds each time you save new changes to the branch. The URL format is `organization-branch-name.mintlify.site`. + +Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication on the [Add-ons](https://app.mintlify.com/products/addons) page of your dashboard. + +## Which preview to use + +| Feature | Live preview | Preview deployment | +|---|---|---| +| **Speed** | Instant | Requires a build | +| **Access** | Local URL | Shareable URL | +| **Use when** | Reviewing changes while editing | Sharing with your team for review | +| **Availability** | While the editor is open | As long as the branch exists | + +## Share an editor link + +To point a teammate at a specific page on a branch, copy the URL from your browser's address bar. Anyone with access to your Mintlify organization can open it in their own editor session. + +```text +https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} +``` + +For example: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` + +## Review and merge pull requests + +When a pull request is open for the current branch, the publish menu shows a review panel with the number of changed files and current review status. + +After a reviewer approves, click **Merge and publish** to merge and deploy from the editor. The editor switches you back to your deployment branch after merging. + +### Approve from the editor + +For GitHub repositories, reviewers can approve open pull requests without leaving the editor. An **Approve pull request** button appears in the review panel if your account has permission to review it. The status updates to **Approved** and **Merge and publish** becomes available. + +If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it. + + + Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub help or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab help. + + +### Compare changes before merging + +Click any changed file in the publish menu to open it in diff view against the published version. Visual mode shows a visual diff and source mode shows a text diff. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable. + +[Hidden pages](/organize/hidden-pages) that appear in the branch diff are openable from the publish menu, even though they don't appear in your site navigation. + +### Pull request titles and descriptions + +If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor generates one listing the files you created, updated, moved, or deleted. To control how those are written, set [PR instructions](/editor/settings#pr-instructions). + +If your branch has open comment threads, Mintlify adds a summary of them to the pull request description. See [Collaborate](/editor/collaborate#comments). + +## Review an automation run + +When an [automation](/automations) opens a pull request, you can open the editor on the automation's branch: + +- From the **Automation Runs** page in your dashboard, click **Open in editor** on a completed run. +- From a Slack notification, click the **View changes** link. + +Either entry point opens the editor on the automation's branch with the changed pages preselected in the publish menu. You can review the diff and merge or request changes without leaving the editor. The [agent](/editor/agent#continue-an-automation-run) opens alongside it with context on what the automation did. diff --git a/editor/settings.mdx b/editor/settings.mdx index 63bda28d5..4a590e6da 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -1,73 +1,22 @@ --- title: "Editor settings for AI and publishing" -description: "Configure AI instructions, pull request defaults, and the default merge method to control how the Mintlify web editor publishes changes." -keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "lock branch"] +sidebarTitle: "Settings" +description: "Configure editor appearance, AI instructions, and publishing defaults to control how the Mintlify web editor looks and how it commits and merges changes." +keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- -The web editor has two layers of settings: +The editor [settings page](https://app.mintlify.com/settings/deployment/editor) controls the appearance, publishing behavior, and agent behavior. -- **Your settings** apply only to you and control how the editor's AI assists with your edits. -- **Publishing settings** apply to everyone on a deployment and shape what happens when you commit changes and turn them into pull requests. +- **Appearance**: Personal preferences for how the editor looks and behaves. These apply only to you. +- **Publishing**: Deployment-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. +- **Chat**: Persistent instructions for the editor's AI agent. +- **Danger zone**: Actions that can't be undone. -You can configure both from the settings panel. To open it, click the settings icon in the editor toolbar. +## PR instructions -## AI instructions - -AI instructions are persistent guidance that the editor sends to the AI alongside your request. Use them to capture style and tone rules you don't want to repeat every time, like voice, terminology, or formatting conventions. - -Your instructions apply to: - -- **Edit with AI** actions on a selection, such as rewrite, expand, or fix. -- **Agent sessions** started from the editor. - -Each teammate maintains their own instructions, scoped to their user account. - -### When to use AI instructions - -Add AI instructions when you find yourself repeating the same guidance in prompts, for example: - -- Enforcing second-person voice or sentence case headings. -- Preferring specific product names or terminology. -- Banning marketing language or filler phrases. -- Requiring certain components, like always using `` for callouts. - -Keep instructions short and specific. The AI follows them on every request, so vague or contradictory rules degrade results. - -### Configure AI instructions - -1. Click the settings icon in the editor toolbar. -2. In the **AI instructions** field, enter the guidance you want the AI to follow. -3. Save your changes. - -Example: - -```text -- Use second person ("you") and active voice. -- Use sentence case for all headings. -- Refer to the product as "Acme" — never "Acme Inc." or "the platform". -- Wrap notes and warnings in or components. -- Do not add introductory filler like "In this guide" or "Let's explore". -``` - -Leave the field empty to remove your instructions. - -## Publishing settings - -You configure publishing settings per deployment, and they apply to everyone who publishes from the editor. They control how the editor generates, opens, and merges pull requests and commits. - -You need admin access to your Mintlify deployment to change publishing settings. - -### Lock the deployment branch - -To make your deployment branch (usually `main`) read-only in the editor, lock the deployment branch. - -Use this setting when your team wants all editor changes to create pull requests from feature branches. +PR instructions guide the AI when it generates a pull request title and description. They apply whenever the editor opens a pull request on your behalf, including from **Create pull request** and **Merge and publish** flows. -### Pull request instructions - -Pull request instructions guide the AI when it generates a pull request title and description. They apply whenever the editor opens a pull request on your behalf, including from **Create pull request** and **Merge and publish** flows. - -Use pull request instructions to standardize what reviewers see, for example: +Use PR instructions to standardize what reviewers see, for example: - Required sections like **Summary** and **Changes**. - A description template that links to a tracking system. @@ -82,58 +31,66 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -### Main branch autocommits - -When you enable main branch autocommits, the editor commits changes shortly after you stop typing. - -Use this setting when your team edits the deployment branch directly and wants updates to reach Git without a manual publish step. If you want to review changes before they publish to your site, do not use autocommits. - -Edits on feature branches created from the editor autocommit regardless of this setting. Changes on a feature branch never publish unless you merge them into your deployment branch. +Instructions are limited to 20,000 characters. -### Create pull requests as drafts by default +## Main branch autocommits -Turn this on to have the editor open every new pull request in draft state. You can't merge a draft pull request until you mark it ready for review. This is useful when: +Main branch autocommits push changes to your main branch automatically, shortly after you stop typing. If you enable this setting, the editor **hides branches and the publish step entirely**. Changes go live with no review. -- Your team requires a manual review pass before a pull request is open for approval. -- You want to share preview URLs without signaling that the change is ready to merge. - -You can still mark a pull request as ready for review from your Git provider. + + With main branch autocommits on, there is no pending state and no chance to review. Every edit reaches your live site shortly after you stop typing. + -### Default merge method +## PR merge method Choose how the editor merges pull requests when you click **Merge and publish**: -- **Merge**: Creates a merge commit that preserves the full branch history. +- **Merge**: Creates a merge commit that preserves the full branch history. This is the default. - **Squash**: Combines all commits in the branch into a single commit on your deployment branch. - **Rebase**: Replays each commit from the branch onto your deployment branch without a merge commit. -The editor uses the selected method by default. If you pass an explicit merge method through the API or your Git provider's UI, that choice takes precedence. +If you pass an explicit merge method through the API or your Git provider's UI, that choice takes precedence. - Match your default merge method to your Git provider's branch protection settings. If your deployment branch only allows squash merges, set the default to **Squash** to avoid failed merges from the editor. + Match your merge method to your Git provider's branch protection settings. If your deployment branch only allows squash merges, set the method to **Squash** to avoid failed merges from the editor. -## Danger zone +## AI instructions -The **Danger zone** section of the editor settings panel contains actions that can't be undone. Click the settings icon in the editor toolbar then scroll to **Danger zone**. +AI instructions are persistent guidance that the editor sends to the AI alongside your request. Use them to capture style and tone rules you don't want to repeat every time, like voice, terminology, or formatting conventions. -### Reset editor +Your instructions apply to: -**Reset editor** forces the editor to discard its local state and sync with your Git repository. If the editor gets stuck out of sync with your repo, reset the editor. Reset the editor if the file tree is empty or shows errors like `Unable to find docs.json`. This can happen even though the file exists on your deployment branch and your live site builds normally. +- **Edit with AI** actions on a selection, such as rewrite, expand, or fix. +- **Agent sessions** started from the editor. - - If you reset the editor, you discard any unpublished changes that you haven't committed to Git. If you have pending edits you want to keep, publish them first. - +Each teammate maintains their own instructions, scoped to their user account. Instructions are limited to 20,000 characters. -To reset the editor: +Add AI instructions when you find yourself repeating the same guidance in prompts, for example: -1. Click the settings icon in the editor toolbar. -2. Scroll to **Danger zone**. -3. Click **Reset editor** and confirm. +- Enforcing second-person voice or sentence case headings. +- Preferring specific product names or terminology. +- Banning marketing language or filler phrases. +- Requiring certain components, like always using `` for callouts. + +Keep instructions short and specific. The AI follows them on every request, so vague or contradictory rules degrade results. + +Example: + +```text +- Use second person ("you") and active voice. +- Use sentence case for all headings. +- Refer to the product as "Acme"—never "Acme Inc." or "the platform". +- Wrap notes and warnings in or components. +- Do not add introductory filler like "In this guide" or "Let's explore". +``` -The editor reloads and pulls the latest state from your repository. +Leave the field empty to remove your instructions. -## Related +## Reset editor -- [Branching and publishing](/editor/branching-and-publishing) -- [Configurations](/editor/configurations) +**Reset editor** forces the editor to discard its local state and sync with your Git repository. Reset the editor if it gets stuck out of sync with your repo, for example if the file tree is empty or shows errors like `Unable to find docs.json`. This can happen even though the file exists on your deployment branch and your live site builds normally. + + + If you reset the editor, you discard any unpublished changes that you haven't committed to Git. If you have pending edits you want to keep, publish them first. + diff --git a/editor/suggestions.mdx b/editor/suggestions.mdx deleted file mode 100644 index cf23291f1..000000000 --- a/editor/suggestions.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Suggest changes in the editor" -sidebarTitle: "Suggestions" -description: "Propose text changes as suggestions that teammates can review, accept, or reject in the editor without modifying the current page content." -keywords: ["suggestions", "suggesting", "collaboration", "review"] ---- - -Suggestions let you propose changes to text while preserving the current content. Teammates can review, accept, or reject your suggestions. - -Suggesting mode applies to page text. Editors and admins can accept or reject any suggestion, but viewers cannot. See [roles](/dashboard/roles) for details. - -Pending suggestions appear as highlighted text in the editor. The sidebar lists them alongside comments so reviewers can find them. - -## Make suggestions - -1. Highlight any text on the page. -2. Click the **Switch to Suggesting** button in the toolbar. -3. In suggesting mode, edit any text. Deletions and insertions appear with highlighting so that reviewers can identify the changes you propose. -4. To exit suggesting mode, click the **Switch to Editing** button in the floating toolbar or the **X** on the **Suggesting** pill in the top bar. - - - [Viewers](/dashboard/roles) are always in suggesting mode. Suggesting mode activates automatically when a viewer opens the editor. The **Suggesting** pill is visible but not interactive for viewers, so they remain in suggesting mode. This lets viewers propose changes without directly editing content. - - - - The switch to suggesting button in the floating toolbar above selected text in the editor. - The switch to suggesting button in the floating toolbar above selected text in the editor. - - -## Accept a suggestion - -1. Click the highlighted suggestion text. -2. Click the **Accept** button to apply the suggested change. - -Accepting a suggestion resolves and deletes the suggestion thread. The accepted change becomes part of your current branch and goes live the next time you [publish](/editor/branching-and-publishing). - -## Reject a suggestion - -1. Click the highlighted suggestion text. -2. Click the **Reject** button to discard the proposed change. - -Rejecting a suggestion resolves and deletes the suggestion thread. diff --git a/es.json b/es.json index 45df02e5f..54e1db698 100644 --- a/es.json +++ b/es.json @@ -15,6 +15,7 @@ "root": "es/cli/index", "pages": [ "es/cli/install", + "es/cli/mdx-extension", "es/cli/preview", "es/cli/commands" ] @@ -99,15 +100,11 @@ "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/publish", + "es/editor/review", + "es/editor/collaborate", "es/editor/agent", - "es/editor/configurations", "es/editor/settings", "es/editor/keyboard-shortcuts" ] diff --git a/es/changelog.mdx b/es/changelog.mdx index ba3a2b614..02fb893cd 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -11,7 +11,7 @@ noindex: true ## Editor y colaboración
- - **Branches v2 e historial de versiones:** Las ramas del editor ahora se respaldan con pull requests en borrador y guardan automáticamente los cambios en Git. Puedes renombrar o eliminar ramas, descartar cambios guardados automáticamente y mover cambios pendientes a una rama nueva. El menú de ramas se ordena por actividad reciente, usa nombres por usuario y muestra nombres `Draft ` más claros para las ramas generadas automáticamente. Consulta [Ramas y publicación](/es/editor/branching-and-publishing). + - **Branches v2 e historial de versiones:** Las ramas del editor ahora se respaldan con pull requests en borrador y guardan automáticamente los cambios en Git. Puedes renombrar o eliminar ramas, descartar cambios guardados automáticamente y mover cambios pendientes a una rama nueva. El menú de ramas se ordena por actividad reciente, usa nombres por usuario y muestra nombres `Draft ` más claros para las ramas generadas automáticamente. Consulta [Ramas y publicación](/es/editor/publish). - **Navegación simplificada del editor:** El editor tiene una nueva fila de breadcrumbs, controles de página y uso compartido consolidados, encabezados de sección fijos en la barra lateral y una barra inferior dedicada a la configuración y **Ask agent**. En pantallas pequeñas, la navegación móvil ahora usa una barra superior simplificada y una barra lateral en forma de panel. - **Acceso a páginas y comentarios:** Solicita acceso de edición a una página privada o protegida desde el editor y revisa las solicitudes en un modal de aprobación. Las tarjetas de comentarios ahora muestran fotos de perfil y las @menciones enlazan al usuario mencionado. - **Mejoras de live preview:** Ejecuta varias vistas previas locales al mismo tiempo. Los cambios de navegación se propagan a las vistas previas abiertas, el panel del agente se acopla a la izquierda y la vista previa permanece visible durante los turnos de seguimiento del onboarding. @@ -179,7 +179,7 @@ noindex: true
- **Flujo de revisión:** Solicita la revisión de un borrador, deja comentarios y aprueba o solicita cambios antes de publicar. Las revisiones ahora admiten ramas que no son de despliegue. - - **Más formas de colaborar:** Inicia [hilos de comentarios](/es/editor/comments) sobre una página completa, menciónate para dejar un recordatorio y usa los atajos de teclado Option + C u Option + S para comentar o sugerir cambios en el texto seleccionado. + - **Más formas de colaborar:** Inicia [hilos de comentarios](/es/editor/collaborate#comments) sobre una página completa, menciónate para dejar un recordatorio y usa los atajos de teclado Option + C u Option + S para comentar o sugerir cambios en el texto seleccionado. - **Edición más rápida y disponible:** El editor se renderiza sin esperar al árbol de archivos de Git y las personas sin acceso de escritura en GitHub pueden usarlo.
@@ -236,7 +236,7 @@ noindex: true ## Mejoras del editor
- - **Borradores:** Trabaja en cambios sin publicar sin crear una rama ni usar comandos de Git. Consulta [Borradores](/es/editor/branching-and-publishing) para obtener más información. + - **Borradores:** Trabaja en cambios sin publicar sin crear una rama ni usar comandos de Git. Consulta [Borradores](/es/editor/publish) para obtener más información. - **Bloquea la rama de despliegue:** El editor ahora te pide bloquear tu rama de despliegue si detecta protecciones de rama. - **[Agente del editor](/es/editor) más rápido con mejor función de deshacer/rehacer:** Las actualizaciones del agente ahora se transmiten al instante, la navegación es más rápida y los cambios de contenido y del árbol de navegación se pueden deshacer y rehacer de forma limpia. - **El estado de los encabezados plegables se mantiene por usuario:** Tus preferencias de secciones expandidas y colapsadas se conservan entre sesiones del editor. @@ -1071,7 +1071,7 @@ noindex: true - Se rediseñó la página de configuración del editor con un diseño mejorado y soporte de autoguardado. - Las páginas generadas automáticamente a partir de especificaciones OpenAPI ahora aparecen en el editor web como entradas de solo lectura. - - Soporte de video en la [vista previa en vivo](/es/editor/live-preview). Los archivos mp4, webm y mov incrustados ahora se renderizan correctamente durante el desarrollo local. + - Soporte de video en la [vista previa en vivo](/es/editor/review#live-preview). Los archivos mp4, webm y mov incrustados ahora se renderizan correctamente durante el desarrollo local. - Las [automatizaciones](/es/automations) ahora se pueden deshabilitar y volver a habilitar desde el dashboard. - Los análisis del asistente ahora muestran el uso desglosado por fuente (web vs API) en el dashboard. - La búsqueda MCP autenticada ahora filtra correctamente los resultados según los grupos de autenticación del usuario. @@ -1620,7 +1620,7 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a ## Mejoras en el editor web - * Se añadieron [enlaces de vista previa compartibles](/es/editor/branching-and-publishing#access-and-share-a-preview) en la barra de herramientas del editor. + * Se añadieron [enlaces de vista previa compartibles](/es/editor/review#preview-deployments) en la barra de herramientas del editor. * Se actualizó el [flujo de publicación](/es/editor/publish) para permitir la publicación con un solo clic o la creación de solicitudes de extracción. * Trabajar en el editor web ya no requiere que inicies sesión con GitHub. diff --git a/es/cli/index.mdx b/es/cli/index.mdx index aa840435f..579bffb0e 100644 --- a/es/cli/index.mdx +++ b/es/cli/index.mdx @@ -86,5 +86,6 @@ https://mcp.mintlify.com
- [Instalar la CLI](/es/cli/install): Instala la CLI y prepárala para usarla. +- [Extensión Mintlify MDX](/es/cli/mdx-extension): Agrega autocompletado, verificación de errores en línea y una previsualización en el editor. - [Previsualización local](/es/cli/preview): Ejecuta un servidor de desarrollo local con soporte de búsqueda y asistente. - [Comandos](/es/cli/commands): Referencia completa de todos los comandos y flags. diff --git a/es/cli/install.mdx b/es/cli/install.mdx index 3e8609fc7..73737d430 100644 --- a/es/cli/install.mdx +++ b/es/cli/install.mdx @@ -121,14 +121,16 @@ Si `mint update` no está disponible en tu versión, reinstala la CLI con la úl ``` -
- ## Formato +
+ ## Soporte para editores
-Para resaltado de sintaxis y formato de código en archivos MDX, recomendamos usar las siguientes extensiones: +Para resaltado de sintaxis, autocompletado y verificación de errores en archivos MDX, usa las siguientes extensiones: -- **Cursor, Devin Desktop, VS Code**: [Extensión MDX para VS Code](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) y [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) -- **JetBrains**: [Plugin MDX para IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) y [Prettier](https://prettier.io/docs/webstorm) +- **Cursor, Devin Desktop, VS Code**: [Extensión Mintlify MDX](/es/cli/mdx-extension) y [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) para el formato. +- **JetBrains**: [Plugin MDX para IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) y [Prettier](https://prettier.io/docs/webstorm). + +También puedes formatear archivos MDX con [`mint format`](/es/cli/commands#mint-format).
## Solución de problemas diff --git a/es/cli/mdx-extension.mdx b/es/cli/mdx-extension.mdx new file mode 100644 index 000000000..cd1128c27 --- /dev/null +++ b/es/cli/mdx-extension.mdx @@ -0,0 +1,169 @@ +--- +title: "Extensión Mintlify MDX" +description: "Instala la extensión Mintlify MDX para obtener autocompletado, diagnósticos en línea, documentación al pasar el cursor y una previsualización en el editor mientras escribes MDX localmente." +keywords: ["Cursor", "MDX", "autocompletado", "diagnósticos", "IntelliSense", "previsualización", "editor"] +--- + +La extensión Mintlify MDX agrega compatibilidad de lenguaje para proyectos de Mintlify a VS Code, Cursor, Devin Desktop y otros editores compatibles con la API de extensiones de VS Code. La extensión conoce todos los componentes y propiedades integrados, por lo que obtienes autocompletado mientras escribes, y reporta componentes desconocidos, propiedades inválidas e importaciones de snippets sin resolver. + +La extensión también ejecuta una previsualización en vivo dentro de tu editor, para que puedas escribir y ver el resultado renderizado sin cambiar a un navegador. + +
+ ## Requisitos previos +
+ +- VS Code 1.85.0 o más reciente +- Un directorio de documentación con un archivo `docs.json` válido +- La [CLI de Mintlify](/es/cli/install), solo para la previsualización en el editor + +
+ ## Instalar la extensión +
+ +Instala desde la línea de comandos: + +```bash +code --install-extension mintlify.mintlify-snippets +``` + +O instala desde tu editor: + +1. Abre la vista de Extensiones. +2. Busca `@id:mintlify.mintlify-snippets`. +3. Haz clic en **Install**. + +También puedes instalarla desde el [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). + +La extensión se activa cuando abres un archivo `.mdx` o un espacio de trabajo que contiene un archivo `docs.json`. + +
+ ## Autocompletado +
+ +Escribe `<` para ver todos los componentes integrados. El autocompletado sugiere las propiedades y los valores de los componentes dentro de las etiquetas. + +La extensión sugiere los componentes que importas desde [snippets reutilizables](/es/create/reusable-snippets) junto con los integrados. + +
+ ## Diagnósticos +
+ +La extensión reporta problemas en el panel de Problemas y los subraya en tu archivo mientras escribes: + +- Componentes desconocidos. +- Propiedades desconocidas o duplicadas. +- Valores inválidos para propiedades enumeradas. +- Propiedades requeridas faltantes. +- Etiquetas sin cerrar o mal emparejadas. +- Importaciones de snippets sin resolver. + +Estas clases de errores causan fallos de compilación, así que corrígelos mientras escribes para evitar despliegues fallidos. + +Para desactivar los diagnósticos, establece `mintlify.diagnostics.enabled` en `false`. + +
+ ## Documentación al pasar el cursor +
+ +Pasa el cursor sobre un componente o una propiedad para ver qué hace y un enlace a su página en la documentación de Mintlify. Al pasar el cursor sobre un componente de snippet se previsualiza el contenido del archivo de snippet. + +
+ ## Ir a la definición +
+ +Mantén presionado CMD (macOS) o CTRL (Windows) y haz clic para navegar a la definición de: + +- Componentes de snippet. +- Rutas de importación. +- Atributos `href` y `src` que apuntan a páginas locales. + +La extensión encuentra la raíz de tu documentación subiendo desde el archivo abierto hasta encontrar `docs.json`, por lo que las importaciones absolutas como `/snippets/example.mdx` se resuelven correctamente. El proyecto detectado aparece en la barra de estado. Para comprobar qué raíz está usando la extensión, ejecuta **Mintlify: Show detected docs root** desde la paleta de comandos. + +
+ ## Validación de configuración +
+ +La extensión valida `docs.json` contra el [esquema de Mintlify](https://mintlify.com/docs.json). + +
+ ## Previsualización en tu editor +
+ +Abre un archivo `.mdx` y selecciona el icono de previsualización en la barra de título del editor, o haz clic derecho en el archivo y selecciona **Preview Mintlify**. Un panel de previsualización se abre junto a tu editor y renderiza la página. + +Las previsualizaciones en el editor requieren la [CLI de Mintlify](/es/cli/install). La URL del servidor en ejecución aparece en la barra de estado. Selecciónala para detener el servidor, o ejecuta **Mintlify: Stop preview server**. + +Para ver la salida del proceso `mint dev` subyacente, abre el canal de salida **Mintlify Preview**. + + + Usa la previsualización en el editor mientras escribes páginas individuales, y [`mint dev`](/es/cli/preview) en un navegador cuando quieras probar la navegación, la búsqueda o la autenticación en todo tu sitio. + + +
+ ## Envolver contenido en componentes +
+ +La extensión incluye snippets que envuelven el texto seleccionado en un componente, en lugar de insertar un componente vacío para que lo completes. + +Para usarlos, selecciona el contenido que quieres envolver, luego ejecuta **Snippets: Surround With** desde la paleta de comandos y elige un componente. Hay snippets disponibles para `AccordionGroup`, `CardGroup`, `CodeGroup`, `Expandable`, `Frame`, `RequestExample`, `ResponseExample` y bloques de código delimitados. + +
+ ## Configuración +
+ +| Configuración | Valor predeterminado | Descripción | +| --- | --- | --- | +| `mintlify.diagnostics.enabled` | `true` | Reporta componentes desconocidos, propiedades desconocidas, propiedades requeridas faltantes e importaciones de snippets sin resolver. | +| `mintlify.warnAboutConflictingExtensions` | `true` | Advierte cuando tienes otra extensión MDX instalada junto a la extensión Mintlify MDX. | +| `mintlify.preview.command` | `mint dev --no-open` | Comando usado para iniciar el servidor de previsualización, ejecutado desde la raíz de tu proyecto. | +| `mintlify.preview.followScroll` | `true` | Desplaza la previsualización hasta el encabezado más cercano a la parte superior de tu editor. | + +`mintlify.preview.command` es una configuración de usuario, por lo que un espacio de trabajo no puede sobrescribirla. Esto evita que un repositorio clonado ejecute un comando arbitrario en tu máquina cuando abres una previsualización. + +
+ ## Comandos +
+ +Ejecútalos desde la paleta de comandos: + +| Comando | Descripción | +| --- | --- | +| **Mintlify: Preview Mintlify** | Abre el panel de previsualización para el archivo actual. | +| **Mintlify: Stop preview server** | Detiene el servidor de previsualización en ejecución. | +| **Mintlify: Show detected docs root** | Muestra qué archivo `docs.json` resolvió la extensión. | +| **Mintlify: Open component docs** | Abre la documentación del componente en tu cursor. | +| **Mintlify: Restart language server** | Reinicia el servidor de lenguaje. | + +
+ ## Extensiones en conflicto +
+ +Otras extensiones MDX proporcionan su propio resaltado de sintaxis y funciones de lenguaje para archivos `.mdx`, que entran en conflicto con esta extensión. Desactiva otras extensiones MDX para evitar sugerencias duplicadas y resaltado inconsistente. + +Para el formato de código, usa [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) junto con esta extensión o ejecuta [`mint format`](/es/cli/commands#mint-format). + +
+ ## Solución de problemas +
+ + + + La extensión resuelve los componentes en relación con la raíz de tu documentación. Ejecuta **Mintlify: Show detected docs root** para confirmar que encontró el archivo `docs.json` correcto. Si la raíz es incorrecta o falta, abre la carpeta que contiene tu archivo `docs.json` como tu espacio de trabajo. + + Si la raíz es correcta, ejecuta **Mintlify: Restart language server**. + + + Es probable que otra extensión MDX también esté activa. Abre la vista de Extensiones, busca `mdx` y desactiva cualquier otra extensión MDX en este espacio de trabajo. + + + Abre el canal de salida **Mintlify Preview** para ver el error de `mint dev`. + + - `could not run "mint dev --no-open"`: La CLI no está instalada. Instálala con `npm i -g mint`. + - `Trust the workspace first`: Confía en el espacio de trabajo a través de **Manage Workspace Trust**. + - `no docs.json found above this file`: Abre la carpeta que contiene tu archivo `docs.json` como tu espacio de trabajo. + - `Invalid docs.json`: Ejecuta [`mint validate`](/es/cli/commands#mint-validate) para encontrar el error de configuración. + + + Las rutas de importación absolutas se resuelven desde la raíz de tu documentación, no desde tu archivo. Confirma que la ruta coincide con la ubicación del archivo de snippet en relación con tu archivo `docs.json`, y que la raíz detectada es correcta. + + diff --git a/es/cli/preview.mdx b/es/cli/preview.mdx index d8dd74d91..33f5481e5 100644 --- a/es/cli/preview.mdx +++ b/es/cli/preview.mdx @@ -35,6 +35,10 @@ Para generar una previsualización sin instalar la CLI globalmente, ejecuta: npx mint dev ``` + + Si escribes en VS Code o Cursor, la [extensión Mintlify MDX](/es/cli/mdx-extension) ejecuta esta previsualización en un panel junto a tu editor y la desplaza para coincidir con la página que estás editando. + +
## Iniciar sesión para búsqueda y asistente
diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index b88460193..146c884bb 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -581,4 +581,4 @@ Algunas funciones se comportan de manera diferente o no están disponibles cuand | [skill.md](/es/ai/skillmd) | Compatibilidad completa | No compatible | No compatible | | [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | Disponible tras autenticación, pero excluye las páginas en groups | | [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación | -| [Vista previa en vivo](/es/editor/live-preview) | Compatibilidad completa | Compatible con autenticación automática del editor | Compatible con autenticación automática del editor | +| [Vista previa en vivo](/es/editor/review#live-preview) | Compatibilidad completa | Compatible con autenticación automática del editor | Compatible con autenticación automática del editor | diff --git a/es/editor/agent.mdx b/es/editor/agent.mdx index 055114df8..499a55ee1 100644 --- a/es/editor/agent.mdx +++ b/es/editor/agent.mdx @@ -1,12 +1,12 @@ --- title: "Preguntar al agente" -description: "Usa el agente de IA integrado del editor para escribir y editar páginas, dejar comentarios y sugerencias, buscar en el sitio y ajustar la configuración." +description: "Use el agente de IA integrado del editor para escribir contenido, editar páginas, dejar comentarios y sugerencias, buscar en su sitio, subir archivos y ajustar la configuración." keywords: ["editor", "AI", "assistant", "agent", "chat", "comments", "suggestions", "code mode", "file upload"] --- -El editor incluye un agente integrado que puede editar páginas, reorganizar la navegación, actualizar `docs.json`, buscar en todo su repositorio y gestionar la configuración del panel. +El editor incluye un agente integrado que puede editar páginas, reorganizar la navegación, actualizar `docs.json`, buscar en todo su repositorio y gestionar la configuración del dashboard. -El agente del editor realiza los cambios directamente en la branch actual. +El agente del editor realiza los cambios directamente en su branch actual.
@@ -14,21 +14,11 @@ El agente del editor realiza los cambios directamente en la branch actual.
-Haga clic en **Ask agent** en la barra de herramientas del editor, o presione Cmd + I (macOS) o Ctrl + I (Windows). +Haga clic en **Ask agent** en la barra de herramientas del editor o presione Cmd + I (macOS) o Ctrl + I (Windows). -Para cerrar el panel, haga clic en el botón **X** del encabezado del panel o vuelva a presionar Cmd + I. +Escriba @ para mencionar una página concreta y el agente se centrará en ella. Sin una mención, usa la página que tiene abierta. -
- -## Enviar un mensaje - -
- -Escriba su solicitud en el cuadro de chat en la parte inferior del panel y presione Enter o haga clic en el botón de envío . - -Escriba @ para mencionar una página específica. El agente se centra en esa página al procesar su solicitud. Si no menciona ninguna página, el agente utiliza la página que tiene abierta en ese momento. - -Ejemplos de prompts: +Prompts de ejemplo: - `simplify the introduction page` - `fix all grammar errors across my content` @@ -42,14 +32,14 @@ Ejemplos de prompts:
-Haga clic en el icono del clip en el cuadro de chat, o arrastre y suelte archivos en el panel. El agente lee los archivos adjuntos como contexto para su solicitud. +Haga clic en el icono del clip en el cuadro de chat o arrastre y suelte archivos en el panel. El agente lee los archivos adjuntos como contexto para su solicitud. Tipos de archivo admitidos: - **Imágenes**: JPG, PNG, GIF, WebP, SVG - **Documentos**: PDF - **Código y texto**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, scripts de shell y más -Tamaño máximo: 5 MB por archivo, excepto los archivos SVG, que están limitados a 256 KB. Máximo: 10 archivos por mensaje. +Tamaño máximo: 5 MB por archivo, salvo los archivos SVG, limitados a 256 KB. Máximo: 10 archivos por mensaje. Mintlify elimina los scripts y otro contenido activo de los archivos SVG antes de que el agente los lea. @@ -59,26 +49,26 @@ Mintlify elimina los scripts y otro contenido activo de los archivos SVG antes d
-En modo visual, seleccione texto en una página. Aparece una barra de herramientas flotante sobre la selección. Haga clic en **Add to agent** para enviar el texto seleccionado al agente como contexto. +En el modo visual, seleccione un texto y haga clic en **Add to agent** en la barra de herramientas flotante para enviarlo al agente como contexto.
-## Solicitar comentarios y sugerencias +## Pedir comentarios y sugerencias
-De forma predeterminada, el agente edita el contenido directamente. Para obtener feedback sin cambiar la página de inmediato, pídale explícitamente al agente que revise la página, deje comentarios o haga sugerencias. +De forma predeterminada, el agente edita el contenido directamente. Para obtener opiniones sin cambiar la página de inmediato, pídale explícitamente que revise la página, deje comentarios o haga sugerencias. -- Las [sugerencias](/es/editor/suggestions) proponen un reemplazo específico que puede aceptar o rechazar. El texto original permanece visible tachado hasta que decida, y el agente puede incluir una explicación en el hilo de la sugerencia. -- Los [comentarios](/es/editor/comments) dejan feedback o una pregunta anclada a un texto específico sin cambiar la página. +- Las [sugerencias](/es/editor/collaborate#suggestions) proponen un reemplazo concreto que puede aceptar o rechazar. El texto original permanece visible tachado hasta que decida, y el agente puede incluir una explicación en el hilo de la sugerencia. +- Los [comentarios](/es/editor/collaborate#comments) dejan una opinión o una pregunta anclada a un texto concreto sin cambiar la página. -Ejemplos de prompts: +Prompts de ejemplo: - `review this page and leave suggestions` - `comment on anything that needs more context` - `suggest ways to make the introduction more concise` -El agente utiliza la página que tiene abierta en ese momento a menos que indique otra. Puede anotar el texto renderizado de la página, incluida la prosa dentro de los componentes, pero no el frontmatter, los metadatos de la página, la configuración ni las etiquetas y atributos crudos de los componentes MDX. +El agente usa la página que tiene abierta salvo que indique otra. Puede anotar el texto representado de la página, incluida la prosa dentro de los componentes. No puede anotar el frontmatter, los metadatos de la página, la configuración ni las etiquetas y atributos MDX en bruto.
@@ -86,11 +76,11 @@ El agente utiliza la página que tiene abierta en ese momento a menos que indiqu
-A medida que el agente edita sus páginas, aparece un panel **Changed files** en el chat. Expándalo para ver una lista de cada archivo modificado en la sesión. Haga clic en cualquier archivo para abrirlo en la vista de diff y comparar los cambios del agente con el original. +Aparece un panel **Changed files** en el chat mientras el agente trabaja. Despliéguelo para ver todos los archivos modificados en la sesión y haga clic en cualquiera para comparar los cambios con el original en la vista de diff.
-## Lo que el agente puede hacer +## Qué puede hacer el agente
@@ -100,7 +90,7 @@ A medida que el agente edita sus páginas, aparece un panel **Changed files** en
-El agente puede escribir, reescribir, ampliar y reorganizar contenido en cualquier página. Lee su contenido existente para adaptarse a su estilo y estructura. +El agente puede escribir, reescribir, ampliar y reorganizar el contenido de cualquier página. Lee su contenido existente para adaptarse a su estilo y estructura.
@@ -108,25 +98,25 @@ El agente puede escribir, reescribir, ampliar y reorganizar contenido en cualqui
-El agente puede buscar en todo su repositorio, no solo en la página que tiene abierta. Úselo para encontrar información, comprobar inconsistencias o verificar que el contenido existe antes de añadirlo. +El agente puede buscar en todo su repositorio, no solo en la página que tiene abierta. Úselo para encontrar información, detectar incoherencias o comprobar que un contenido ya existe antes de añadirlo. -
+
### Actualizar la navegación y docs.json
-El agente puede añadir, renombrar, reordenar y eliminar elementos de navegación, los mismos cambios que haría manualmente en el panel de navegación. También puede actualizar la configuración de `docs.json` directamente, incluyendo añadir nuevos grupos, ajustar opciones y configurar redirecciones. +El agente puede añadir, renombrar, reordenar y eliminar elementos de navegación, los mismos cambios que haría manualmente en el panel de navegación. También puede actualizar la configuración de `docs.json` directamente, incluido añadir groups nuevos, ajustar opciones y configurar redirecciones. Ejemplo: `add a "Quickstart" group under the Getting Started tab and move the quickstart page into it`
-### Ejecutar comandos bash +### Ejecutar comandos de bash
-El agente puede ejecutar `grep`, `rg` y otros comandos bash sobre su repositorio. Úselo para operaciones masivas que abarquen muchos archivos. +El agente puede ejecutar `grep`, `rg` y otros comandos de bash sobre su repositorio. Úselo para operaciones masivas que abarcan muchos archivos. Ejemplo: `find every page that mentions the deprecated /v1/auth endpoint` @@ -136,11 +126,11 @@ Ejemplo: `find every page that mentions the deprecated /v1/auth endpoint`
-Para solicitudes que van más allá de editar páginas (configurar autenticación, gestionar workflows o cambiar ajustes de despliegue), el agente cambia a code mode. Escribe y ejecuta un script contra su panel de Mintlify en su nombre. +Para solicitudes que van más allá de editar páginas (configurar la autenticación, gestionar workflows o cambiar los ajustes del deployment), el agente pasa al code mode. Escribe y ejecuta un script contra su dashboard de Mintlify en su nombre. -Code mode respeta sus permisos del panel. Si no tiene acceso a un ajuste en el panel, el agente tampoco puede cambiarlo. +El code mode respeta sus permisos del dashboard. Si no tiene acceso a un ajuste en el dashboard, el agente tampoco puede cambiarlo. -Ejemplos de prompts que usan code mode: +Prompts de ejemplo que usan code mode: - `enable JWT authentication for my site` - `create a workflow that updates my site when I merge a PR` @@ -152,9 +142,9 @@ Ejemplos de prompts que usan code mode:
-Cuando abres el editor desde una ejecución de automatización completada haciendo clic en **Ver cambios**, el panel del agente se abre automáticamente con contexto sobre lo que hizo la automatización. Una tarjeta de **Páginas modificadas** en la parte superior del chat lista cada página que la automatización modificó: haz clic en cualquier página para abrir una vista de diff. +Cuando abre el editor desde una ejecución de automatización completada haciendo clic en **View changes**, el panel del agente se abre automáticamente con contexto sobre lo que hizo la automatización. Una tarjeta **Changed pages** en la parte superior del chat enumera todas las páginas que modificó la automatización. Haga clic en cualquier página para abrir una vista de diff. -El agente tiene contexto sobre el prompt de la automatización, un resumen de los cambios que realizó y qué páginas modificó. Puedes pedirle que refine o amplíe el trabajo de la automatización sin tener que volver a explicar el contexto. +El agente dispone del prompt de la automatización, de un resumen de los cambios que hizo y de las páginas que modificó. Puede pedirle que refine o amplíe su trabajo sin volver a explicarle el contexto. Por ejemplo: `The new section on rate limits is too long. Trim it to three sentences.` @@ -164,7 +154,7 @@ Por ejemplo: `The new section on rate limits is too long. Trim it to three sente
-Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones de chat anteriores. Haga clic en cualquier sesión para volver a abrirla y ver lo que cambió el agente. +Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones de chat anteriores. Haga clic en cualquier sesión para reabrirla y ver qué cambió el agente.
@@ -172,4 +162,4 @@ Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones
-Para dar al agente pautas persistentes como reglas de voz, terminología o convenciones de formato, configure las instrucciones de IA en la [configuración del editor](/es/editor/settings#ai-instructions). El agente sigue estas instrucciones en cada solicitud sin que tenga que repetirlas. +Para dar al agente directrices persistentes, como reglas de voz, terminología o convenciones de formato, configure las instrucciones de IA en la [configuración del editor](/es/editor/settings#ai-instructions). El agente sigue estas instrucciones en cada solicitud sin que tenga que repetirlas. diff --git a/es/editor/branching-and-publishing.mdx b/es/editor/branching-and-publishing.mdx deleted file mode 100644 index e1d097d1f..000000000 --- a/es/editor/branching-and-publishing.mdx +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: "Branches y publicación" -description: "Comprenda cómo las branches y las reglas de protección determinan lo que sucede al publicar, y cómo gestionar el flujo completo de revisión y despliegue." -keywords: ["editor", "branch", "publish", "pull request", "preview", "git", "merge", "deploy"] ---- - -El editor web guarda todo automáticamente mientras escribe, pero sus cambios solo están en producción cuando decide publicarlos. - -Lo que sucede al publicar depende de dos cosas: **en qué branch se encuentre** y **si esa branch requiere pull requests**. - -
- -## Guardar frente a publicar - -
- -**Guardar** ocurre automáticamente. Mintlify almacena sus ediciones en sus servidores y las conserva entre pestañas del navegador, dispositivos e interrupciones de red. - -**Publicar** confirma sus cambios en su repositorio de Git. Haga clic en **Publish** en la barra de herramientas para abrir el menú de publicación, guardar sus cambios como un commit de Git y crear una pull request. - -El editor registra lo siguiente como cambios pendientes: - -- Ediciones de contenido en páginas -- Páginas nuevas o eliminadas -- Cambios en la estructura de navegación -- Cargas de medios -- Actualizaciones de configuración - -
- -## Lo que sucede al publicar - -
- -Las acciones disponibles al hacer clic en el botón de publicar dependen de la branch actual y de si tiene reglas de protección de branch que exigen pull requests. - -| Tipo de branch | Protección de branch | Acciones disponibles | -|-------------|-------------------|-------------------| -| Deployment branch | Ninguna | **Publish** directamente en su sitio en producción | -| Deployment branch | Se requieren pull requests | **Create branch** para mover los cambios a una nueva branch | -| Feature branch | Ninguna | **Save in branch**, **Create pull request** | -| Feature branch | Se requieren pull requests | **Save in branch**, **Create pull request** | - -- **Publish**: Confirma y despliega sus cambios en su sitio en producción de inmediato. -- **Save in branch**: Confirma sus cambios en la feature branch sin fusionarlos con su deployment branch. -- **Create branch**: Mueve sus cambios pendientes a una nueva feature branch cuando se encuentra en una deployment branch protegida. -- **Create pull request**: Abre una pull request dirigida a su deployment branch. - -Si no hay cambios pendientes, el editor desactiva las acciones de publicar y guardar. - - - Su sitio en producción se actualiza después de que Mintlify compile y despliegue sus cambios. Esto suele tardar de 30 segundos a unos pocos minutos. Compruebe el estado del despliegue en su [panel](https://app.mintlify.com). - - -
- -## Cuándo usar una branch - -
- -**Edite directamente en su deployment branch** si no utiliza un flujo de trabajo basado en Git. - -**Cree una branch** cuando utilice un flujo de trabajo basado en branches en el que realiza cada cambio en su contenido en una branch separada. - -
- -## Crear y cambiar de branch - -
- -
- -### Crear una branch - -
- -1. Haga clic en el nombre de la branch en la barra de herramientas del editor. -1. Haga clic en **Create new branch**. -1. Si tiene cambios pendientes, elija si llevarlos a la nueva branch o dejarlos en la branch actual. -1. Introduzca un nombre y haga clic en **Create branch**. - - - Use nombres descriptivos para las branches de modo que pueda identificarlas fácilmente y otras personas comprendan para qué sirve cada una. - - -
- -### Cambiar de branch - -
- -1. Haga clic en el nombre de la branch en la barra de herramientas. -1. Busque o desplácese hasta la branch que desee. -1. Haga clic en la branch para cambiar a ella. - - - Si cambia de branch cuando tiene cambios sin publicar, se le pedirá que lleve esos cambios a la nueva branch o que los deje atrás. Los cambios dejados atrás permanecen en su branch original. - - - - Para copiar el nombre de una branch, pase el cursor sobre la branch en el menú desplegable y haga clic en el icono de copiar. Esto resulta útil al compartir la branch con sus compañeros de equipo o al referenciarla en una pull request. - - -
- -## Previsualizar sus cambios - -
- -Cada vez que guarda cambios en una feature branch, Mintlify compila un despliegue de vista previa, una URL temporal donde sus cambios se renderizan exactamente como cuando se publican. - -
- -### Acceder y compartir una vista previa - -
- -1. Haga clic en **Publish** en la barra de herramientas del editor. -1. En el menú de publicación, haga clic en la URL de vista previa. El formato de la URL es `organization-branch-name.mintlify.site`. - - URL de vista previa destacada en el menú de publicación. - URL de vista previa destacada en el menú de publicación. - - -Copie la URL y envíela a los revisores. La vista previa se actualiza automáticamente cada vez que guarda en la branch. - -
- -### Restringir el acceso a las vistas previas - -
- -Las URLs de vista previa son públicamente accesibles por defecto. Para restringir el acceso a los miembros de su organización en Mintlify, habilite la autenticación de vista previa en la página [Add-ons](https://app.mintlify.com/products/addons) de su panel. - - - -Para invitar a un compañero de equipo a una página específica en una branch, copie la URL de la barra de direcciones de su navegador y compártala. Cualquier persona con acceso a su organización de Mintlify puede abrir el enlace directamente en su sesión del editor. - -El formato de la URL es: - -```text -https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} -``` - -Por ejemplo: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` - -
- -## Revisar y fusionar pull requests - -
- -Cuando hay una pull request abierta para la branch actual, el menú de publicación muestra un panel de revisión con: - -- El título y la descripción de la pull request, y si es un borrador. -- Las branches de origen y de destino. -- El número de archivos modificados. -- El requisito de aprobación en la deployment branch: **Approval required**, **Code owner required** o sin requisito. -- El estado actual de la revisión: **Approved**, **Changes requested** o **Awaiting review**. - -Haga clic en el enlace de la pull request para abrirla en GitHub, GitLab o Bitbucket. - -Después de que un revisor apruebe una pull request, haga clic en **Merge and publish** para fusionar y desplegar directamente desde el editor. El editor cambia a su deployment branch después de fusionar. - -
- -### Aprobar pull requests desde el editor - -
- -Para los repositorios de GitHub, los revisores pueden aprobar pull requests abiertas en el editor. Cuando hay una pull request abierta, aparece el botón **Approve pull request** en el panel de revisión si su cuenta tiene permiso para revisarla. Haga clic en **Approve pull request** cuando los cambios estén listos para fusionarse. El estado de la revisión cambia a **Approved** y la acción **Merge and publish** queda disponible. - -Si usa GitLab o Bitbucket, abra la pull request en su proveedor de Git para aprobarla. - - - Configure reglas de protección de branches en su proveedor de Git para exigir pull requests. Consulte [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) en la ayuda de GitHub o [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) en la ayuda de GitLab. - - -
- -### Revisar los cambios antes de fusionar - -
- -Haga clic en cualquier archivo modificado en el menú de publicación para abrirlo en la vista de diff y comparar su branch con la versión publicada. En modo visual verá un diff visual. En modo source verá un diff de texto. Los archivos que no pueden mostrar un diff, como imágenes o archivos eliminados, aparecen en la lista pero no se pueden abrir. - -El árbol de archivos resalta las páginas modificadas para que pueda ver de un vistazo qué archivos ha tocado una [automatización](/es/automations) o un compañero de equipo. Las páginas no listadas que aparecen en el diff de la branch también se pueden abrir desde el menú de publicación, aunque no aparezcan en la navegación de su sitio. - -
- -### Abrir una ejecución de automatización en el editor - -
- -Cuando una [automatización](/es/automations) abre una pull request, puede saltar directamente desde la interfaz de revisión de la ejecución o desde su notificación de Slack al editor en la branch de la automatización: - -- Desde la página **Automation Runs** en su panel, haga clic en **Open in editor** en una ejecución completada. -- Desde una notificación de Slack, haga clic en el enlace **View changes**. - -Cualquiera de los dos accesos abre el editor en la branch de la automatización con las páginas modificadas preseleccionadas en el menú de publicación. Puede revisar el diff y fusionar o solicitar cambios sin salir del editor. - -
- -### Publicaciones simultáneas - -
- -Solo puede haber una publicación a la vez por branch. Si otro miembro del equipo publica en la misma branch, espere a que termine la publicación actual antes de volver a intentarlo. - -
- -### Títulos y descripciones de pull requests - -
- -Si su organización requiere pull requests, puede introducir un título y una descripción al publicar. Si deja cualquiera de los dos en blanco, el editor usa un mensaje predeterminado que enumera los archivos que ha creado, actualizado, movido o eliminado. - -
- -## Resolver conflictos - -
- -Los conflictos ocurren cuando su branch y la deployment branch tienen cambios incompatibles en los mismos archivos. Por ejemplo, cuando usted y un compañero de equipo han editado las mismas líneas en un archivo o han movido un archivo a ubicaciones diferentes. - -El editor muestra una advertencia cuando los conflictos bloquean la publicación. Siga las indicaciones para elegir qué versión de cada sección en conflicto conservar. - -
- -## Colaborar en tiempo real - -
- -Cuando varias personas abren la misma página en la misma branch, editan juntas en tiempo real. El cursor y las ediciones de cada persona son visibles para todos, con avatares mostrados en la barra de herramientas. - -- Los cambios de todos los colaboradores se fusionan automáticamente. Dos personas editando la misma sección no generarán conflictos. -- Deshacer solo afecta a sus propias ediciones. -- Si pierde la conexión, las ediciones se guardan localmente y se sincronizan cuando se vuelve a conectar. - -Cuando el [agente de Mintlify](/es/agent) edita una página a través de la API o MCP, aparece en el editor como cualquier otro colaborador. Verá el avatar del agente en la barra de herramientas y un cursor en vivo en su edición más reciente. El cursor desaparece automáticamente después de que el agente termina. - -
- -## Sincronización con Git - -
- -Cuando alguien envía cambios a su repositorio desde fuera del editor, el editor incorpora esos cambios automáticamente. - -Los cambios que no se solapan se aplican automáticamente. Si un cambio remoto y su edición local afectan a la misma parte de una página, el editor resalta el conflicto para que pueda resolverlo. - -
- -## Firma de commits - -
- -Firme commits con su cuenta de GitHub autorizándola en la [configuración de su cuenta](https://app.mintlify.com/settings/account). Sin autorización, la app de GitHub de Mintlify firma los commits realizados en el editor web. - -Para una referencia de cómo las acciones del editor se corresponden con las operaciones de Git, consulte [Conceptos básicos de Git](/es/editor/git-essentials#how-the-editor-maps-to-git). diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx new file mode 100644 index 000000000..d2bea2e0b --- /dev/null +++ b/es/editor/collaborate.mdx @@ -0,0 +1,82 @@ +--- +title: "Colaborar en el editor" +sidebarTitle: "Colaborar" +description: "Deje comentarios, proponga cambios como sugerencias y edite junto a sus compañeros en tiempo real en el editor." +keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] +--- + +Trabaje con su equipo en una página comentándola, sugiriendo cambios o editándola conjuntamente al mismo tiempo. + +
+ +## Comentarios + +
+ +Los comentarios le permiten dejar opiniones sobre un texto concreto sin editar el contenido. + +**Los comentarios nunca llegan a su repositorio.** Existen solo dentro del editor y nunca se incluyen en el sitio publicado ni se confirman en Git. + +Para añadir un comentario, resalte un texto y haga clic en el icono **Comment** de la barra de herramientas. Para responder, haga clic en el texto resaltado o en el hilo de la barra lateral de comentarios. + + + El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor. + El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor. + + +Todos los [roles](/es/dashboard/roles) pueden comentar y responder, incluidos los viewers. Solo los editors y admins pueden resolver hilos. Resolver un hilo lo quita de la barra lateral y elimina el resaltado de la página. + +Puede eliminar sus propios comentarios y los admins pueden eliminar cualquier comentario. Eliminar el primer comentario de un hilo elimina el hilo completo. + +Escriba `@` para mencionar a un compañero. Debe ser miembro de su organización y recibirá una notificación por correo electrónico. + +Si su branch tiene una pull request abierta, Mintlify añade a su descripción un resumen de los hilos sin resolver, con un enlace a cada comentario. El resumen se actualiza a medida que cambian los hilos. + +
+ +## Sugerencias + +
+ +Las sugerencias proponen un cambio manteniendo el contenido actual, de modo que un compañero pueda aceptarlas o rechazarlas. + +Los editors y admins pueden aceptar o rechazar cualquier sugerencia. Los viewers no. + +Para hacer una sugerencia, resalte un texto y haga clic en el botón **Switch to Suggesting** de la barra de herramientas. En el modo de sugerencias, sus eliminaciones e inserciones aparecen como texto resaltado en lugar de como ediciones. Las sugerencias pendientes aparecen en la barra lateral junto a los comentarios. + + + Los [viewers](/es/dashboard/roles) están siempre en modo de sugerencias. El modo de sugerencias se activa automáticamente cuando un viewer abre el editor, de forma que pueda proponer cambios sin editar el contenido directamente. + + +Haga clic en una sugerencia resaltada para aceptarla o rechazarla. Cualquiera de las dos opciones resuelve y elimina el hilo de la sugerencia. Un cambio aceptado pasa a formar parte de su branch actual y se publica la próxima vez que [publique](/es/editor/publish). + +
+ +## Preguntar al agente de Mintlify + +
+ +Mencione `@mintlify` en un comentario, una sugerencia o una respuesta para preguntar al [agente del editor](/es/editor/agent) sobre la página actual. El agente se ejecuta en segundo plano con la página, el hilo y la branch como contexto, y luego publica su respuesta en el mismo hilo. + +```text +@mintlify does this endpoint support pagination? +@mintlify are there any pages that contradict this? +``` + +El agente funciona en modo de solo lectura cuando responde a comentarios. Puede buscar en su documentación, leer páginas, consultar contenido web y cargar skills, pero no puede editar contenido, crear sugerencias ni publicar. Para hacer cambios, abra directamente el [agente del editor](/es/editor/agent). + +Las menciones funcionan en páginas privadas para los miembros que ya tienen acceso. Cada respuesta cuenta para su uso del agente del editor. + +
+ +## Edición en tiempo real + +
+ +Cuando varias personas abren la misma página en la misma branch, editan conjuntamente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas. + +- Los cambios de todos los colaboradores se combinan automáticamente. Que dos personas editen la misma sección no genera conflictos. +- Deshacer solo afecta a sus propias ediciones. +- Si pierde la conexión, sus ediciones se guardan localmente y se sincronizan cuando vuelve a conectarse. + +Cuando el [agente de Mintlify](/es/agent) edita una página a través de la API o de MCP, aparece como cualquier otro colaborador, con un avatar y un cursor en vivo en su edición más reciente. El cursor desaparece cuando el agente termina. diff --git a/es/editor/comments.mdx b/es/editor/comments.mdx deleted file mode 100644 index 6227c572b..000000000 --- a/es/editor/comments.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "Comentarios" -description: "Deja comentarios en línea en las páginas del editor para dar retroalimentación, mencionar compañeros, hacer preguntas y discutir cambios con tu equipo." -keywords: ["editor", "comentarios", "colaboración", "retroalimentación", "menciones", "hilos"] ---- - -Los comentarios te permiten a ti y a tu equipo dejar retroalimentación sobre texto específico de una página sin editar el contenido. Usa los comentarios para hacer preguntas, señalar problemas o discutir cambios antes de publicarlos. - -Los comentarios solo existen dentro del editor. Nunca se incluyen en el sitio publicado ni se envían a tu repositorio. - -Todos los [roles](/es/dashboard/roles)—viewers, editors y admins—pueden dejar comentarios y responder a ellos. Solo los editors y admins pueden resolver hilos de comentarios. - -Si tu branch tiene una pull request abierta, Mintlify agrega un resumen de los hilos de comentarios sin resolver a la descripción de la pull request. El resumen enumera los archivos con comentarios abiertos, el primer comentario de cada hilo y un enlace para navegar hasta el comentario en el editor. - -El resumen se actualiza cuando agregas, resuelves o eliminas un comentario. - -
- ## Agregar un comentario -
- -1. Resalta el texto sobre el que quieres comentar. -2. Haz clic en el icono **Comment** en la barra de herramientas. -3. Escribe tu comentario y presiona Enter para enviarlo. - - - El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor web. - El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor web. - - -
- ## Responder a un comentario -
- -Para abrir un hilo de comentarios, haz clic en el texto resaltado o en el hilo en la barra lateral de comentarios. Escribe tu respuesta y presiona Enter para enviarla. - - - Un hilo de comentarios abierto en el editor web y dos hilos de comentarios en la barra lateral. - Un hilo de comentarios abierto en el editor web y dos hilos de comentarios en la barra lateral. - - -
- ## Mencionar a un compañero -
- -Escribe `@` en un comentario o respuesta para mencionar a un compañero. Las personas deben ser miembros de tu organización para que puedas mencionarlas. - -Los compañeros mencionados reciben una notificación por correo electrónico. - -
- ## Preguntar al agente de Mintlify -
- -Menciona `@mintlify` en un comentario, [sugerencia](/es/editor/suggestions) o respuesta para hacerle una pregunta al [agente del editor](/es/editor/agent) sobre la página actual. El agente se ejecuta de forma asíncrona con la página, el hilo y la branch como contexto, y luego publica su respuesta como una nueva respuesta en el mismo hilo. - -Usa las menciones `@mintlify` para hacer preguntas como: - -- `@mintlify does this endpoint support pagination?` -- `@mintlify is this the recommended way to configure webhooks?` -- `@mintlify are there any pages that contradict this?` - -El agente se ejecuta en modo de solo lectura cuando responde a comentarios. Puede buscar en tu documentación, leer páginas, obtener contenido web y cargar skills, pero no puede editar contenido, crear sugerencias ni publicar cambios. Para hacer cambios, abre el [agente del editor](/es/editor/agent) directamente. - -Las menciones `@mintlify` funcionan en páginas privadas para los miembros que ya tienen acceso. Cada respuesta del agente cuenta para tu uso del agente del editor. - -
- ## Resolver un comentario -
- -Los editors y admins pueden resolver los hilos cuando la discusión finaliza. - -Haz clic en el icono de marca de verificación para resolver un hilo. Los hilos resueltos se eliminan de la barra lateral de comentarios y se elimina el resaltado de la página. - - - Un hilo de comentarios abierto en el editor web con el icono de marca de verificación para resolver el hilo resaltado. - Un hilo de comentarios abierto en el editor web con el icono de marca de verificación para resolver el hilo resaltado. - - -
- ## Eliminar un comentario -
- -Haz clic en el icono de papelera junto a un comentario para eliminarlo. Eliminar el primer comentario de un hilo elimina todo el hilo. - -Puedes eliminar tus propios comentarios. Los admins pueden eliminar cualquier comentario. diff --git a/es/editor/configurations.mdx b/es/editor/configurations.mdx deleted file mode 100644 index 3d302ee13..000000000 --- a/es/editor/configurations.mdx +++ /dev/null @@ -1,274 +0,0 @@ ---- -title: "Configuraciones" -description: "Edite la marca, apariencia, navegación y funciones desde el panel Configurations en el editor web de Mintlify, con sincronización en tiempo real." -keywords: ["editor", "configurations", "settings", "branding", "theme"] -boost: 3 ---- - -Configure la marca, la apariencia y las funciones de su sitio desde el panel **Site configurations** en el editor web. Los cambios de configuración se sincronizan en tiempo real con otros editores en la misma branch, de modo que su equipo siempre ve los ajustes más recientes. - -Para abrir el panel, haga clic en el icono de configuraciones en la barra de herramientas del editor. - - - Menú de Configurations en el editor. - Menú de Configurations en el editor. - - -El panel agrupa los ajustes en secciones que se corresponden con las propiedades de nivel superior de su [`docs.json`](/es/organize/settings). - -
- -## General - -
- -Establezca la identidad de su sitio y cómo aparece para los visitantes. - -- **Name**: El nombre de su proyecto. Aparece en las pestañas del navegador y en los resultados de búsqueda. -- **Description**: Breve descripción de su proyecto. Se utiliza para SEO y AEO. - -
- -## Marca - -
- -Suba las marcas que identifican su sitio. - -- **Logo**: El logo de su marca. Suba archivos PNG o JPG. Establezca versiones separadas para modo claro y oscuro y una URL opcional al hacer clic. Para usar un logo SVG, añada el archivo a su repositorio y referencie su ruta en su [`docs.json`](/es/organize/settings-appearance#logos). -- **Favicon**: Pequeño icono que aparece en las pestañas del navegador. Suba archivos ICO, PNG, GIF o JPG. Establezca versiones separadas para modo claro y oscuro si es necesario. - -
- -## Estilo - -
- -Controle la identidad visual y la paleta de colores de su sitio. - -- **Theme**: Elija un [tema](/es/customize/themes) para la apariencia general de su sitio. -- **Primary color**: El color de acento principal usado en todo su sitio para enlaces, botones y elementos destacados. -- **Light color**: Color de acento usado en modo oscuro. La forma en que los temas lo aplican varía según el tema. -- **Dark color**: Color de acento usado en modo claro. La forma en que los temas lo aplican varía según el tema. -- **Background color**: Colores de fondo personalizados para modo claro y oscuro. -- **Icon library**: Biblioteca de iconos usada para todas las propiedades de iconos. El valor predeterminado es `fontawesome`. -- **Strict appearance**: Bloquea el sitio en un único modo de apariencia y oculta el conmutador de tema. -- **Default appearance**: Indica si su sitio se carga en modo `system`, `light` o `dark` por defecto. -- **Background decoration**: Aplica un estilo visual (`gradient`, `grid` o `windows`) al fondo. -- **Background image**: Imagen de fondo opcional. Establezca una sola imagen o versiones separadas para modo claro y oscuro. - -
- -## Tipografía - -
- -Reemplace las fuentes predeterminadas con la tipografía de su marca. - -- **Font family**: Cualquier familia de [Google Fonts](https://fonts.google.com/) funciona sin configuración adicional. Para una fuente alojada por usted mismo, proporcione una URL de origen y un formato (`woff` o `woff2`). -- **Weight**: Normalmente `400` para regular y `700` para negrita. Las fuentes variables admiten pesos precisos como `550`. -- **Heading font**: Anulación opcional aplicada a todos los encabezados (`h1` a `h6`). -- **Body font**: Anulación opcional aplicada al cuerpo de texto y al resto de la página. - - - -Añada elementos de navegación a la parte superior de su sitio. - -- **Primary button**: La llamada a la acción principal en su cabecera. Establezca el tipo, la etiqueta y la URL de destino. -- **Navbar links**: Enlaces de navegación adicionales en su cabecera. Cada enlace incluye un texto y una URL. - - - -Añada enlaces y perfiles de redes sociales al pie de página de su sitio. - -- **Social links**: Perfiles en plataformas como GitHub, X, LinkedIn, Discord, YouTube y Slack. -- **Footer columns**: Habilítelo para organizar los enlaces del pie de página en hasta cuatro columnas con encabezados personalizados. - - - -Muestre una barra de anuncios en la parte superior de cada página. - -- **Content**: El texto del banner. Admite formato MDX básico como enlaces, negrita y cursiva. Los componentes personalizados no son compatibles. -- **dismissible**: Muestra un botón para descartar en el lado derecho del banner. -- **Type**: Estilo visual. `info` usa el color primario de la marca, `warning` usa un fondo ámbar y `critical` usa un fondo rojo. El valor predeterminado es `info`. -- **Color**: Anula el color de fondo del banner con un color hexadecimal personalizado. Establezca valores separados para modo claro y oscuro para colores adaptables al tema. - -
- -## Miniatura - -
- -Personalice las miniaturas de las páginas y las vistas previas para redes sociales. - -- **Background**: Imagen de fondo personalizada para las miniaturas. -- **Appearance**: Renderiza las miniaturas en modo `light` o `dark`. Cuando no se define, las miniaturas se generan automáticamente a partir de los colores de su tema. -- **Font**: Fuente personalizada para el texto en las miniaturas. - -
- -## Contenido - -
- -Personalice cómo aparece el contenido en su sitio. - -- **Page eyebrow**: Muestra etiquetas pequeñas que preceden a los títulos de las páginas. Elija `section` o `breadcrumbs`. -- **Timestamps**: Muestra la fecha de la última modificación del contenido en todas las páginas. -- **LaTeX**: Carga las hojas de estilo de LaTeX (KaTeX) para renderizar notación matemática. - -
- -## Bloques de código - -
- -Configure el resaltado de sintaxis y el comportamiento de los bloques de código. - -- **Code block theme**: Iguala el modo claro/oscuro del sitio con `system`, usa siempre un tema oscuro con `dark` o elija un tema personalizado de [Shiki](https://shiki.style/). -- **Custom code languages**: Registre lenguajes adicionales para el resaltado de sintaxis. - -
- -## Menú contextual - -
- -Configure las acciones rápidas que aparecen en el menú contextual de la página. - -- **Options**: Menú desplegable de selección múltiple con acciones como `copy`, `view` y abrir la página en `chatgpt`, `claude`, `cursor` y otros asistentes de IA. -- **Display**: Dónde mostrar las opciones. `header` (predeterminado) las muestra en el menú contextual en la parte superior de la página; `toc` las muestra en la barra lateral del índice de contenido. - - - -Ajuste el comportamiento de la navegación en todo su sitio. - -- **drilldown**: Navega automáticamente a la primera página cuando un usuario hace clic en un grupo de navegación. - - - -Personalice la experiencia de búsqueda y los comentarios. - -- **Search placeholder**: El texto que aparece en el cuadro de búsqueda antes de que los usuarios escriban. El valor predeterminado es `Search or ask`. -- **Feedback**: Muestra botones de pulgar arriba y pulgar abajo o un enlace "Suggest edits" en cada página. - -
- -## Referencia de API - -
- -Documente los endpoints de su API. - -- **OpenAPI specs**: Añada archivos de especificación OpenAPI para generar páginas de referencia de API. -- **AsyncAPI specs**: Añada archivos de especificación AsyncAPI para generar páginas de referencia de API. -- **MDX server**: Endpoints personalizados del servidor MDX para el playground de API. -- **Playground display**: Muestra el playground interactivo de la API, el playground simple de la API o ningún playground de API. -- **Proxy server**: Habilita o deshabilita el servidor proxy para las solicitudes de API. -- **`mdx.schema`**: Indica si se renderiza la sección de esquema en las páginas de referencia de API. - -
- -## Redirecciones - -
- -Use la sección **Redirects** para añadir, editar, buscar y eliminar redirecciones sin editar manualmente su archivo `docs.json`. Las redirecciones envían a los usuarios desde URLs antiguas a otras nuevas, lo cual es útil cuando renombra páginas o reestructura su sitio. Para más información, consulte [Redirecciones](/es/create/redirects). - -Cada redirección tiene los siguientes campos: - -- **Source**: La ruta desde la que redirigir, como `/old-path`. Admite comodines. -- **Destination**: La ruta a la que redirigir, como `/new-path`. Admite comodines. -- **Status**: El código de estado HTTP para la redirección. - - `308`: Redirección permanente. Úselo para contenido que se ha movido de forma permanente. Este es el estado predeterminado. - - `307`: Redirección temporal. Úselo cuando el movimiento es temporal. - - - Menú de redirecciones en el editor. - Menú de redirecciones en el editor. - - -Para añadir una redirección: - -1. Haga clic en **Add redirect**. -2. Introduzca el origen y el destino. -3. Haga clic en **Save**. - -Para editar o eliminar una redirección existente, pase el cursor sobre la fila y use el icono de edición en línea o la **X** para eliminarla. - -
- -## SEO - -
- -Configure las metaetiquetas y la indexación para los motores de búsqueda. - -- **metatags**: Etiquetas `` personalizadas aplicadas en todo su sitio. Añada pares clave-valor para etiquetas como `og:image` o `twitter:card`. -- **Indexing**: Elija si se deben indexar las páginas ocultas. - -
- -## Analítica - -
- -Conecte plataformas de analítica para rastrear el comportamiento de los visitantes. Los proveedores admitidos incluyen Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit y más. - -Cada entrada se muestra como una fila en línea. Use el icono **X** para eliminar una integración. - -
- -## Página 404 - -
- -Personalice la experiencia cuando un usuario llega a una página inexistente. - -- **Redirect to home**: Cuando está activado, las páginas inexistentes redirigen a su página de inicio. Cuando está desactivado, el sitio muestra una página 404 y puede personalizar el título y la descripción a continuación. -- **Title**: Encabezado que se muestra en la página 404. -- **Description**: Subtítulo que se muestra en la página 404. - -
- -## Variables - -
- -Defina variables personalizadas que se pueden reutilizar en todo su contenido. Cada variable es un par clave-valor. Use el icono **X** para eliminar una variable. diff --git a/es/editor/git-essentials.mdx b/es/editor/git-essentials.mdx deleted file mode 100644 index 4f168d6e2..000000000 --- a/es/editor/git-essentials.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "Conceptos básicos de Git para el editor" -sidebarTitle: "Conceptos básicos de Git" -description: "Comprenda los conceptos de control de versiones de Git detrás del editor de Mintlify: branches, commits, pull requests y flujos de fusión." -keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"] ---- - -Git le permite controlar y hacer seguimiento de los cambios en los archivos. Es el sistema de control de versiones detrás de los flujos de trabajo basados en branches, donde gestiona el contenido del mismo modo que cualquier otra base de código. - -El editor web se encarga de las operaciones de Git por usted. Comprender algunos conceptos clave le ayuda a aprovechar al máximo el editor y a colaborar eficazmente con su equipo. - -
- -## Lo que Git hace por su contenido - -
- -Git registra cada cambio realizado en su contenido. Anota qué cambió, quién lo cambió, cuándo lo cambió y por qué. Esto significa que puede: - -- Ver el historial completo de cualquier página. -- Deshacer cambios revirtiendo a una versión anterior. -- Trabajar en actualizaciones sin afectar a su sitio en producción. -- Revisar los cambios antes de que se publiquen. - -Su repositorio es la colección de archivos y su historial que conforman su sitio. El editor se conecta a este repositorio para sincronizar y publicar su contenido. - -
- -## Conceptos clave - -
- -Estos son los conceptos de Git con los que se encontrará con más frecuencia al usar el editor web. - - - - Una instantánea guardada de sus cambios en un momento específico. Cada commit incluye un mensaje que describe qué cambió y crea un registro permanente en el historial de su proyecto. - - Cuando publica cambios, el editor web crea un commit en su repositorio de Git. - - - Una línea de trabajo independiente en su repositorio. A veces se le llama **feature branch**. - - Su sitio en producción se compila desde una **deployment branch**, normalmente llamada `main`. Otras branches le permiten trabajar en cambios de forma independiente sin afectar a su sitio en producción. Nada en una branch se publica hasta que la fusiona con su deployment branch mediante una pull request. - - Cambie entre branches usando el menú desplegable de branches en la barra de herramientas del editor. Si tiene cambios sin publicar, el editor le permite llevarlos a la nueva branch o dejarlos en su branch actual. - - - La branch que compila su sitio en producción, normalmente llamada `main`. Los cambios fusionados en esta branch se despliegan automáticamente en su sitio. - - - Una propuesta para fusionar cambios de una branch en otra. Las pull requests permiten que su equipo revise y discuta los cambios antes de que se publiquen. - - Cuando publica cambios en una feature branch (o cuando su repositorio exige pull requests), el editor web crea una pull request. Su equipo revisa y fusiona la pull request en su proveedor de Git (GitHub, GitLab o Bitbucket). - - - Combinar cambios de una branch en otra. Después de que su equipo revisa y aprueba una pull request, fusionar la branch incorpora sus cambios en la deployment branch y los publica. - - - Ocurre cuando dos branches tienen cambios incompatibles en los mismos archivos. El editor le ayuda a resolver los conflictos cuando se producen. - - - Una comparación que muestra las diferencias entre dos versiones de un archivo. El editor muestra un diff visual de sus cambios pendientes antes de publicar para que pueda revisar exactamente lo que se va a confirmar. - - - -
- -## Cómo se relaciona el editor con Git - -
- -Cada acción en el editor web corresponde a una operación de Git. Aquí está la referencia completa: - -| Acción en el editor | Operación de Git | -|---|---| -| Editar una página | Los cambios se guardan automáticamente en los servidores de Mintlify. Aún no hay commit de Git. | -| Publicar en su deployment branch | `git commit` y `git push`. Desencadena un despliegue. | -| Save in branch | `git commit` en la feature branch actual. | -| Create pull request | `git push` y abre una pull request contra su deployment branch. | -| Merge and publish | Fusiona la pull request y desencadena un despliegue. | -| Crear una branch | `git checkout -b ` | -| Cambiar de branch | `git checkout ` | -| Push externo o actualización desde la CLI | Los cambios entrantes se sincronizan en el editor automáticamente mediante una fusión a tres bandas. | diff --git a/es/editor/index.mdx b/es/editor/index.mdx index 5f245a6b5..1742d4292 100644 --- a/es/editor/index.mdx +++ b/es/editor/index.mdx @@ -1,21 +1,17 @@ --- title: "Descripción general del editor" sidebarTitle: "Descripción general" -description: "Cree, edite y publique contenido en el navegador con colaboración en tiempo real, guardado automático, vistas previas en vivo y sincronización con Git." -keywords: ["editor", "visual", "collaborative", "web editor"] +description: "Cree, edite y publique contenido en su navegador con el editor de Mintlify. Admite colaboración en tiempo real y sincronización continua con Git." +keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- - - Un recorrido paso a paso: cree una branch, haga un cambio, comparta una vista previa y publique. + + Cree una branch, haga un cambio, comparta una vista previa y publique. -
+Use el editor para escribir y publicar documentación en su navegador. El editor usa un flujo de trabajo docs-as-code en el que Git respalda todos sus cambios. Su trabajo se guarda como commits en su repositorio y el editor gestiona las operaciones de Git por usted. -## Abrir el editor - -
- -Abre el editor desde la pestaña [Editor](https://app.mintlify.com/editor) en tu dashboard de Mintlify. Cualquier miembro de tu organización puede abrir el editor; lo que puedes hacer dentro depende de tu [rol](/es/dashboard/roles). Los admins y editors pueden editar y publicar, y los viewers pueden explorar el contenido y dejar [comentarios](/es/editor/comments) o [sugerencias](/es/editor/suggestions). +El editor se carga de forma predeterminada cuando abre su [dashboard](https://app.mintlify.com). Cualquier miembro de su organización puede abrirlo, pero ciertas acciones dependen de su [rol](/es/dashboard/roles). Los admins y editors pueden editar y publicar. Los viewers pueden explorar el contenido y dejar [comentarios y sugerencias](/es/editor/collaborate).
@@ -23,78 +19,84 @@ Abre el editor desde la pestaña [Editor](https://app.mintlify.com/editor) en tu
-**Los cambios se guardan automáticamente.** A medida que escribe, el editor guarda su trabajo. Sus cambios persisten entre pestañas, dispositivos e interrupciones de red. Los cambios solo se publican cuando usted los publica. +**Los cambios se guardan automáticamente, pero guardar es distinto de publicar.** A medida que escribe, el editor almacena su trabajo. Sus cambios persisten entre pestañas, dispositivos e interrupciones de red. Para que un cambio llegue a su sitio publicado, debe [publicarlo](/es/editor/publish). -**Git se mantiene sincronizado.** Cuando alguien envía cambios a su repositorio desde fuera del editor, esos cambios aparecen automáticamente en el editor. No necesita hacer pull ni actualizar. El editor fusiona los cambios que no entran en conflicto y resalta lo que requiere su atención. +**Publicar escribe en Git.** Cuando publica, el editor hace commit de sus cambios en su repositorio. Si publica en su deployment branch, su sitio publicado se actualiza de inmediato. En una feature branch, puede elegir si al publicar se actualiza el sitio publicado de inmediato o se abre una pull request para revisión. - - Si el editor alguna vez parece estar desincronizado con su repositorio, use [Reset editor](/es/editor/settings#reset-editor) para forzar una resincronización desde Git. Por ejemplo, el árbol de archivos está vacío o muestra `Unable to find docs.json` aunque el archivo esté presente en su deployment branch. - +**Git se mantiene sincronizado.** Cuando alguien hace push a su repositorio, esos cambios aparecen automáticamente. No necesita hacer pull ni actualizar la página. El editor combina los cambios que no entran en conflicto y señala todo lo que requiere su atención. -**Publicar escribe en Git.** Cuando publica, el editor confirma sus cambios en su repositorio. En una deployment branch, esto actualiza su sitio en producción de inmediato. En una feature branch, crea una pull request. +**Su equipo edita en conjunto.** Varias personas pueden editar la misma página a la vez, con cursores en vivo que muestran quién trabaja en cada parte. Los comentarios y las sugerencias son visibles para todos. -**Su equipo edita en conjunto.** Varias personas pueden editar la misma página al mismo tiempo. Los cursores en vivo muestran quién está editando y dónde. + + Si el editor alguna vez parece estar desincronizado con su repositorio, use [Restablecer editor](/es/editor/settings#reset-editor) para forzar una resincronización. Por ejemplo, aparece un árbol de archivos vacío o el error `Unable to find docs.json` cuando el archivo sí está presente en su deployment branch. + -
+
-## El diseño del editor +## Diseño del editor
- Captura de pantalla del editor que muestra el selector de branch, el botón ask agent, el botón publish, la barra lateral de navegación y la barra superior. - Captura de pantalla del editor que muestra el selector de branch, el botón ask agent, el botón publish, la barra lateral de navegación y la barra superior. + Captura de pantalla del editor con la pestaña Publishing seleccionada. + Captura de pantalla del editor con la pestaña Publishing seleccionada. -- **Barra superior**: Use la barra superior para controlar en qué branch trabaja, acceder al agente, ver una vista previa y publicar los cambios. -- **Barra lateral de navegación**: Seleccione una página para editar, cree nuevas páginas y administre la estructura del sitio. +* **Barra superior**: Use la barra superior para controlar en qué branch trabaja, acceder al agente, previsualizar y publicar cambios. +* **Barra lateral**: Use la barra lateral para seleccionar páginas que editar, crear páginas nuevas y gestionar la estructura de su sitio. + * **Home**: El árbol de archivos de su proyecto. Las páginas en **Personal** son privadas para usted. Las páginas en **Workspace** son públicas para su organización. + * **Publishing**: La estructura de navegación de su sitio. Organice las páginas como quiere que aparezcan en su sitio. -
+
-## Explorar el editor +## Modo visual y modo source
- - Cómo las branches y las reglas de protección determinan lo que sucede al publicar, y cómo gestionar el proceso de revisión de pull requests. - - - - Deja retroalimentación, haz preguntas y discute los cambios con tu equipo. - - - - Propón cambios que tus compañeros pueden revisar, aceptar o rechazar. - +**El modo visual** representa su página a medida que escribe. Presione / para abrir el menú de componentes e insertar componentes. - - Edite páginas, busque su contenido, modifique ajustes y configure su sitio desde una interfaz de chat. - +**El modo source** le da acceso directo al MDX. Úselo para tener control preciso sobre las propiedades de los componentes y el frontmatter. - - Añada páginas nuevas y actualice las existentes. - +Ambos modos editan el mismo archivo. Cambie entre ellos con Cmd + Shift + S (macOS) o Ctrl + Shift + S (Windows). - - Reordene las páginas y administre la estructura del sitio. - +Para conocer los componentes que puede insertar, consulte [Componentes](/es/components). Para la sintaxis de MDX, consulte [Dar formato al texto](/es/create/text) y [Dar formato al código](/es/create/code). - - Previsualice su sitio en tiempo real mientras edita, sin esperar a una compilación. - +
- - Configure la marca, los colores y las funciones de su sitio. - +## Conceptos de Git - - Configure las instrucciones de IA y los ajustes predeterminados de publicación para su deployment. - - - - Comprenda los conceptos de Git en los que se basa el editor: branches, commits, pull requests y merges. - +
- - Ahorre tiempo con atajos de teclado. - +Entender algunos conceptos de Git le ayuda a aprovechar mejor el editor. + + + + Una instantánea guardada de sus cambios en un momento concreto, con un mensaje que describe qué cambió. Publicar crea un commit. + + + Una línea de trabajo independiente. Su sitio publicado se compila desde una **deployment branch**, normalmente `main`. Otras branches, a veces llamadas **feature branches**, le permiten trabajar sin afectar su sitio publicado. Nada en una feature branch se publica hasta que hace merge. + + + Una propuesta para hacer merge de una branch en otra, de modo que su equipo pueda revisar los cambios antes de que se publiquen. Su equipo revisa y hace merge de las pull requests en GitHub, GitLab o Bitbucket, o [desde el editor](/es/editor/review). + + + Combinar los cambios de una branch en otra. Hacer merge en su deployment branch publica esos cambios. + + + Dos branches con cambios incompatibles en las mismas líneas. El editor le pide que elija qué versión conservar para resolver los conflictos antes de hacer merge. + + + Una comparación entre dos versiones de un archivo. El editor muestra un diff de sus cambios pendientes antes de que publique. + + + +| Acción en el editor | Operación de Git | +|---|---| +| Editar una página | Se guarda automáticamente. Todavía no hay commit. | +| Publicar en su deployment branch | `git commit` y `git push`. Activa un despliegue. | +| Save in branch | `git commit` en la feature branch actual. | +| Create pull request | `git push` y abre una pull request contra su deployment branch. | +| Merge and publish | Hace merge de la pull request y activa un despliegue. | +| Crear una branch | `git checkout -b ` | +| Cambiar de branch | `git checkout ` | +| Push externo o actualización por CLI | Los cambios entrantes se sincronizan en el editor mediante un merge de tres vías. | diff --git a/es/editor/keyboard-shortcuts.mdx b/es/editor/keyboard-shortcuts.mdx index 398c0b728..21b1e6586 100644 --- a/es/editor/keyboard-shortcuts.mdx +++ b/es/editor/keyboard-shortcuts.mdx @@ -1,10 +1,10 @@ --- title: "Atajos de teclado" -description: "Consulte la lista completa de atajos de teclado para el editor web de Mintlify, incluyendo comandos de formato de texto, navegación y edición." +description: "Consulte la lista completa de atajos de teclado del editor web de Mintlify, incluidos los comandos de formato de texto, navegación y edición." keywords: ["editor", "keys", "keyboard", "shortcuts"] --- -Use atajos de teclado para navegar y editar más rápido en el editor web. El editor admite atajos comunes como copiar, pegar, deshacer y seleccionar todo, junto con los atajos que se enumeran a continuación. +Use los atajos de teclado para navegar y editar más rápido en el editor web. El editor admite atajos habituales como copiar, pegar, deshacer y seleccionar todo, además de los atajos que se enumeran a continuación.
@@ -12,16 +12,14 @@ Use atajos de teclado para navegar y editar más rápido en el editor web. El ed
-Estos atajos funcionan independientemente del modo en el que se encuentre. +Estos atajos funcionan sea cual sea el modo en el que esté. | Comando | macOS | Windows | | :--- | :--- | :--- | | **Buscar archivos y contenido** | Cmd + K | Ctrl + K | -| **Alternar el asistente de IA** (cuando no se edita texto) | Cmd + I | Ctrl + I | -| **Alternar entre modo visual y source** | Cmd + Shift + S | Ctrl + Shift + S | -| **Alternar la vista de diff** | Cmd + Shift + D | Ctrl + Shift + D | -| **Alternar entre Navigation y árbol de Files** | Cmd + Shift + F | Ctrl + Shift + F | -| **Ocultar/mostrar la barra lateral** | Cmd + \\ | Ctrl + \\ | +| **Mostrar u ocultar el asistente de IA** (cuando no está editando texto) | Cmd + I | Ctrl + I | +| **Cambiar entre el modo visual y el modo source** | Cmd + Shift + S | Ctrl + Shift + S | +| **Mostrar todos los archivos** (incluidos los dotfiles y los archivos que no son de contenido) | Cmd + Shift + . | Ctrl + Shift + . |
@@ -29,7 +27,7 @@ Estos atajos funcionan independientemente del modo en el que se encuentre.
-Use estos atajos al editar en modo visual. +Use estos atajos cuando edite en el modo visual.
@@ -49,17 +47,19 @@ Use estos atajos al editar en modo visual.
-### Encabezados +### Títulos
| Comando | macOS | Windows | | :--- | :--- | :--- | | **Texto** | Cmd + Option + 0 | Ctrl + Alt + 0 | -| **Encabezado 1** | Cmd + Option + 1 | Ctrl + Alt + 1 | -| **Encabezado 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | -| **Encabezado 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | -| **Encabezado 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Título 1** | Cmd + Option + 1 | Ctrl + Alt + 1 | +| **Título 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | +| **Título 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | +| **Título 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Título 5** | Cmd + Option + 5 | Ctrl + Alt + 5 | +| **Título 6** | Cmd + Option + 6 | Ctrl + Alt + 6 |
@@ -69,7 +69,7 @@ Use estos atajos al editar en modo visual. | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Lista con viñetas** | Cmd + Shift + 8 | Ctrl + Shift + 8 | +| **Lista sin ordenar** | Cmd + Shift + 8 | Ctrl + Shift + 8 | | **Cita en bloque** | Cmd + Shift + B | Ctrl + Shift + B |
@@ -80,10 +80,10 @@ Use estos atajos al editar en modo visual. | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Añadir enlace** al texto seleccionado | Cmd + K | Ctrl + K | -| **Insertar salto de línea** | Cmd + Enter | Ctrl + Enter | +| **Añadir un enlace** al texto seleccionado | Cmd + K | Ctrl + K | +| **Añadir un salto de línea** | Cmd + Enter | Ctrl + Enter | | **Comentar el texto resaltado** | Cmd + Shift + M | Ctrl + Shift + M | -| **Alternar el modo de sugerencias** | Cmd + Shift + E | Ctrl + Shift + E | +| **Activar o desactivar el modo de sugerencias** | Cmd + Shift + E | Ctrl + Shift + E | | **Menú de componentes** | / | / | | **Selector de emojis** | : + palabra clave | : + palabra clave | @@ -93,9 +93,9 @@ Use estos atajos al editar en modo visual.
-El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos a medida que escribe. El editor omite las sustituciones dentro de bloques de código y código en línea. +El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos mientras escribe. El editor omite las sustituciones dentro de los bloques de código y del código en línea. -| Tipo | Resultado | +| Escriba | Resultado | | :--- | :--- | | `->` | → | | `<-` | ← | @@ -110,7 +110,7 @@ El editor convierte automáticamente ciertas secuencias de caracteres en símbol
-El modo source usa el editor Monaco, que admite los atajos de teclado estándar de VS Code. +El modo source usa CodeMirror. Funcionan la mayoría de los atajos habituales de los editores de código, además de los que aparecen a continuación.
@@ -121,7 +121,7 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar | Comando | macOS | Windows | | :--- | :--- | :--- | | **Buscar archivos** | Cmd + K | Ctrl + K | -| **Buscar** | Cmd + F | Ctrl + F | +| **Buscar en la página** | Cmd + F | Ctrl + F |
@@ -131,12 +131,16 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Comentar/descomentar** | Cmd + / | Ctrl + / | -| **Indentar línea** | Tab | Tab | -| **Quitar sangría de la línea** | Shift + Tab | Shift + Tab | -| **Mover línea hacia arriba** | Option + | Alt + | -| **Mover línea hacia abajo** | Option + | Alt + | -| **Duplicar línea** | Shift + Option + | Shift + Alt + | +| **Negrita** (envuelve en `**`) | Cmd + B | Ctrl + B | +| **Cursiva** (envuelve en `_`) | Cmd + I | Ctrl + I | +| **Comentar o descomentar** | Cmd + / | Ctrl + / | +| **Plegar todo** | Cmd + Option + Shift + [ | Ctrl + Alt + Shift + [ | +| **Desplegar todo** | Cmd + Option + Shift + ] | Ctrl + Alt + Shift + ] | +| **Aumentar la sangría de la línea** | Tab | Tab | +| **Reducir la sangría de la línea** | Shift + Tab | Shift + Tab | +| **Subir la línea** | Option + | Alt + | +| **Bajar la línea** | Option + | Alt + | +| **Duplicar la línea** | Shift + Option + | Shift + Alt + |
@@ -144,8 +148,12 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar
+{/* vale Mintlify.WordList = NO */} + | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Añadir cursor** | Option + clic | Alt + clic | -| **Añadir cursor encima** | Cmd + Option + | Ctrl + Alt + | -| **Añadir cursor debajo** | Cmd + Option + | Ctrl + Alt + | +| **Añadir un cursor** | Option + clic | Alt + clic | +| **Añadir un cursor arriba** | Cmd + Option + | Ctrl + Alt + | +| **Añadir un cursor abajo** | Cmd + Option + | Ctrl + Alt + | + +{/* vale Mintlify.WordList = YES */} diff --git a/es/editor/live-preview.mdx b/es/editor/live-preview.mdx deleted file mode 100644 index 8c52e6493..000000000 --- a/es/editor/live-preview.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "Vista previa en vivo" -description: "Previsualice su sitio en tiempo real mientras edita, con actualizaciones continuas que renderizan al instante los cambios de contenido y configuración." -keywords: ["editor", "preview", "live preview"] ---- - -Previsualice su sitio mientras edita. Las vistas previas en vivo renderizan las páginas exactamente como se ven cuando se publican. Se actualizan a medida que realiza cambios en el contenido, la navegación y la configuración. - -
- -## Abrir la vista previa en vivo - -
- -Haga clic en el botón de vista previa en vivo en la barra superior. - - - El botón de vista previa en vivo en la barra de herramientas. - El botón de vista previa en vivo en la barra de herramientas. - - -
- -## Editar la configuración del sitio en la vista previa en vivo - -
- -Edite la configuración del sitio en la vista previa en vivo para ver cómo afecta al contenido renderizado. - -1. Abra la vista previa en vivo dentro del editor. -2. Haga clic en **Site settings** en la barra de herramientas de la vista previa. -3. Seleccione una sección de configuración y edite sus opciones. - -Si configura la vista previa en vivo para que se abra en una nueva pestaña, el menú de configuración del sitio no estará disponible. Desactive **Open live preview in new tab** en la [configuración del editor](/es/editor/settings) para usar el menú de configuración del sitio. - -
- -## Preguntar al agente en la vista previa en vivo - -
- -Haga clic en **Ask agent** en la barra de herramientas de la vista previa para abrir el [agente del editor](/es/editor/agent) junto a la vista previa en vivo. Solo los editores y administradores pueden usar el agente en las vistas previas en vivo. - - - La vista previa en vivo funciona en sitios públicos y en sitios protegidos con autenticación de Mintlify. En sitios autenticados, el editor inicia sesión automáticamente en la vista previa. - - -
- -## Vista previa en vivo frente a despliegues de vista previa - -
- -| | Vista previa en vivo | Despliegue de vista previa | -|---|---|---| -| **Velocidad** | Al instante | Requiere una compilación | -| **Acceso** | URL local, con autenticación automática para sitios protegidos | URL para compartir | -| **Cuándo usarla** | Para revisar cambios mientras edita | Para compartir con su equipo para su revisión | -| **Disponibilidad** | Mientras el editor esté abierto | Mientras exista la branch | - -Use la vista previa en vivo para obtener retroalimentación inmediata mientras edita. Cuando necesite compartir cambios con su equipo, use un [despliegue de vista previa](/es/editor/branching-and-publishing#preview-your-changes). También puede usarlo para probar los cambios en un dispositivo diferente. diff --git a/es/editor/media.mdx b/es/editor/media.mdx deleted file mode 100644 index 090a82afd..000000000 --- a/es/editor/media.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Agregar contenido multimedia" -description: "Sube, gestiona e inserta imágenes y otros recursos multimedia en tus páginas de documentación usando el gestor de archivos integrado del editor web de Mintlify." -keywords: ["editor","media","images","assets"] ---- - -
- ## Tipos de archivo admitidos -
- -* **Imágenes**: PNG, JPG, JPEG, GIF, WebP (máx. 20 MB) -* **Vídeos**: MP4, WebM (máx. 20 MB) -* **Fuentes**: TrueType (TTF), WOFF, WOFF2 -* **Otros**: PDF, ICO (favicons) - -
- ## Agregar contenido multimedia a una página -
- -
- ### Arrastrar y soltar -
- -Arrastra y suelta contenido multimedia desde tu computadora o desde el gestor de recursos sobre una página. En modo visual, la imagen o el video se insertan en línea. En Modo Markdown, el editor inserta la ruta en la posición de tu cursor. Las imágenes se guardan en la raíz de tu carpeta `images/`, y los videos se guardan en la raíz de tu carpeta `videos/`. - -
- ### Comando slash -
- -Escribe /image para abrir el menú de imágenes o /video para abrir el menú de vídeos. Sube contenido multimedia nuevo o selecciona entre los archivos existentes. - -
- ### Incrustar -
- -Escribe /embed y pega una URL de YouTube, Loom o Vimeo. El editor detecta el proveedor y genera el iframe automáticamente. Al buscar en el menú slash, los términos `youtube`, `yt`, `loom` y `vimeo` también muestran el comando **Embed**. - -Para otras incrustaciones, escribe /embed y activa **Inserción manual** para escribir HTML personalizado. - -
- ### Subir archivos -
- -Usa el explorador de archivos en la barra lateral para subir o buscar archivos. Arrastra y suelta archivos en una carpeta para organizar recursos multimedia. - - - Explorador de archivos abierto en el menú de la barra lateral del editor. - - Explorador de archivos abierto en el menú de la barra lateral del editor. - - -
- ## Formatear imágenes -
- -Después de insertar una imagen en el modo visual, pasa el cursor por encima para mostrar una barra de herramientas con opciones de formato. - -- **Vista previa en modo claro/oscuro**: Cambia entre el modo claro y oscuro para ver cómo se ve la imagen en cada tema. -- **Alineación**: Establece la alineación de la imagen como izquierda, centrada, derecha o a todo el ancho. -- **Frame**: Envuelve la imagen en un componente `` para añadir un borde y un fondo. -- **Configuración**: Reemplaza la imagen o actualiza su texto alternativo. - -
- ## Administra los recursos -
- -
- ### Organiza con carpetas -
- -Haz clic en el botón **+** del explorador de archivos para crear una nueva carpeta. Arrastra y suelta archivos y carpetas en el árbol de archivos para reordenarlos. - -
- ### Renombrar y editar recursos -
- -Pasa el cursor sobre un recurso y haz clic en el botón **...** para cambiar el nombre del archivo o actualizar su texto alternativo (alt). - -
- ### Eliminar recursos -
- -Pasa el cursor sobre un recurso y haz clic en el botón para eliminarlo. - -
- ## Mejores prácticas -
- -- **Usa nombres descriptivos**: Pon nombres claros a los archivos, como `api-dashboard-light.png` en lugar de `img1.png`. -- **Agrega texto alternativo (alt text)**: Proporciona texto alternativo descriptivo para mejorar la accesibilidad y el SEO. -- **Organiza con carpetas**: Agrupa los recursos relacionados, como variantes de modo claro y oscuro o recursos para un área de funcionalidad específica. -- **Usa formatos apropiados**: PNG para gráficos con transparencia, JPG para fotos, SVG para iconos y logotipos (no puedes subir archivos SVG a través del editor, pero puedes agregarlos a tu repositorio mediante Git). \ No newline at end of file diff --git a/es/editor/navigation.mdx b/es/editor/navigation.mdx deleted file mode 100644 index b98f313b7..000000000 --- a/es/editor/navigation.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Organizar la navegación" -description: "Reordena páginas, agrega grupos y gestiona la barra lateral de tu documentación con arrastrar y soltar en el editor web de Mintlify, sin tocar docs.json." -keywords: ["editor", "navigation", "sidebar", "structure"] ---- - -Usa la barra lateral de navegación para organizar tu documentación. Los cambios que realices en el editor se sincronizan con tu repositorio cuando publicas: no necesitas editar `docs.json` manualmente. - -
- ## Agregar elementos de navegación -
- -Haz clic en **Add new** en la parte inferior del árbol de navegación para añadir un nuevo elemento en el nivel raíz. Para añadir un elemento anidado dentro de otro, haz clic en el botón de signo más que aparece junto a ese elemento. - -Arrastra y suelta los elementos para reordenarlos o anidarlos. Pasa el cursor sobre un elemento y haz clic en el icono de engranaje para configurar sus propiedades. - -Haz clic con el botón derecho en una **página** para abrir su configuración o eliminarla. - -Haz clic con el botón derecho en un **elemento de navegación** para abrir su configuración, convertirlo en otro tipo de elemento, duplicarlo, añadir una página o un grupo en su interior, desagruparlo o eliminarlo. - - - Algunos elementos no pueden anidarse dentro de otros. Por ejemplo, las pestañas no pueden anidarse dentro de grupos. El editor te impide crear combinaciones no válidas. - - - - -Elige la estructura adecuada para tu contenido: - -- **Pages**—Archivos individuales de documentación. El bloque de construcción principal de la navegación. -- **Groups**—Secciones plegables que agrupan páginas relacionadas. Pueden anidarse dentro de otros grupos. -- **Tabs**—Secciones de nivel superior con navegación horizontal en la parte superior del sitio. Úsalas cuando tengas áreas distintas como API Reference y Guides. -- **Anchors**—Elementos persistentes en la parte superior de la barra lateral. Útiles para acceder rápidamente a recursos externos o secciones de nivel superior. Pueden ser globales para aparecer en todas las páginas. -- **Dropdowns**—Menús desplegables en la parte superior de la barra lateral. Una alternativa más ligera a las pestañas para varias secciones relacionadas. -- **Menus**—Elementos de navegación desplegables dentro de una pestaña para enlazar directamente con páginas específicas. -- **Products**—Un selector para varios conjuntos de documentación de productos distintos, cada uno con su propia estructura de navegación. -- **Versions**—Un selector para varias versiones simultáneas de la documentación. -- **Languages**—Un selector para documentación en varios idiomas. - -
- ## Configurar elementos -
- -Pasa el cursor sobre cualquier elemento de navegación y haz clic en el icono de engranaje para definir: - -- **Title**: La etiqueta que se muestra en la barra lateral. -- **Icon**: Un marcador visual junto a la etiqueta. -- **Tag**: Una insignia como "NEW" o "BETA" para destacar el elemento. diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index 1887f52d8..c5e0c9be9 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -1,246 +1,94 @@ --- title: "Crear y editar páginas" -description: "Cree páginas, edite contenido, suba imágenes y vídeos y administre archivos en el editor web de Mintlify con edición enriquecida y búsqueda global." -keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages"] +sidebarTitle: "Editar contenido" +description: "Cree páginas, edite contenido, añada archivos multimedia, organice su navegación y recupere versiones anteriores de una página en el editor." +keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- -