diff --git a/agent/index.mdx b/agent/index.mdx index 4a7418ff5b..555f994c11 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -20,6 +20,20 @@ The agent is an AI tool that creates pull requests with proposed changes to your All changes go through pull requests. The agent never commits directly to your main branch. +## Get started + +1. Open the [Agent](https://app.mintlify.com/products/agent) page in your dashboard. +2. Install the Mintlify GitHub App on the repositories you want the agent to work with. +3. Send your first request from the agent panel, from Slack, or by opening a pull request in a connected repository. +4. Review the pull request the agent opens and merge it when you're ready. + +## How the agent stays safe + +- Opens pull requests only. The agent never commits directly to your deployment branch. +- Only accesses repositories that you connect through the Mintlify GitHub App. +- Treats non-documentation repositories as read-only, using them for context but never writing to them. +- Requires human review and merge before any change reaches your live site. + ## What you can do with the agent Use the agent to: diff --git a/agent/slack.mdx b/agent/slack.mdx index 70ff8cd5e3..5e8d8c93a3 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -46,6 +46,15 @@ If you must reauthorize the agent—for example, to grant new permissions after When you reinstall the agent into a workspace that is already connected to your organization, Mintlify refreshes the stored bot token in place. Your existing channels and threads remain intact. +### Disconnect the agent + +To remove the agent from your Slack workspace: + +1. In Slack, go to **Settings & administration > Manage apps** and open the `mintlify` app. +2. Click **Remove app** to uninstall it from the workspace. + +After removal, the agent stops responding to mentions and direct messages. Existing thread history remains in Slack, but the agent cannot access it. Reinstall the app from your Mintlify dashboard to reconnect. + If your organization has multiple deployments, the agent asks you to select which deployment to work with the first time you send a request. @@ -60,8 +69,8 @@ continue where you left off with the new deployment. Once connected, you can: -- Send direct messages to the agent to use it privately. -- Mention `@mintlify` in a channel to use it publicly and collaboratively. +- Send direct messages to the agent to use it privately. Direct messages work as soon as the app is installed. +- Mention `@mintlify` in a channel to use it publicly and collaboratively. The agent only responds in channels it has been invited to—run `/invite @mintlify` in a channel to add it. - Attach files and images directly to your messages for the agent to process and include in your docs. - Continue conversations in threads to iterate on changes or ask follow-up questions. The agent reuses files, images, and emoji reactions from earlier in the thread as context for follow-up requests, so you don't have to reupload them. - Share pull request links with the agent to update related documentation. diff --git a/automations/manage.mdx b/automations/manage.mdx index fc91a6cc18..432d56387e 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -148,6 +148,19 @@ Each run shows one of the following statuses: Click an individual run to see its prompt, the files it read or changed, and any pull request it opened. +### Troubleshoot a failed run + +If a run shows the **Failed** status, open it from the [Automation Runs](https://app.mintlify.com/products/automations) page to see the agent's prompt, tool calls, and error output. + +Common causes: + +- Missing access to a context or source code repository. Reinstall the [Mintlify GitHub App](/deploy/github) on the affected repository. +- A revoked integration token. Reconnect the integration on the [Integrations](https://app.mintlify.com/settings/organization/integrations) page. +- An invalid `docs.json` or validation error in the project repository. +- A schedule or trigger that fires before the previous run has finished. + +After you address the underlying issue, click the run button beside the automation to retry it. Failed runs do not count toward your daily run limit, so retries are safe. + ## Continue a run in the editor After an automation completes and creates changes on a branch, you can open those changes directly in the editor to review, refine, or publish them. diff --git a/automations/reference.mdx b/automations/reference.mdx index f0cf7d864e..418c5e6c71 100644 --- a/automations/reference.mdx +++ b/automations/reference.mdx @@ -6,6 +6,8 @@ keywords: ["predefined", "automation", "default"] Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions from the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. +If none of the predefined automations fit your use case, see [Create a custom automation](/automations/create) to define your own prompt, trigger, and context repositories. + ## At a glance | Automation | Default trigger | Default update mode | Context repos | Required configuration | diff --git a/create/changelogs.mdx b/create/changelogs.mdx index 3f33dbd8bc..10e52a199c 100644 --- a/create/changelogs.mdx +++ b/create/changelogs.mdx @@ -20,6 +20,8 @@ See the [Mintlify changelog](/changelog) as an example: you can include links, i Add an `Update` for each changelog entry. Include relevant information like feature releases, bug fixes, or other announcements. + + Entries appear in the order you list them in the file. Add new entries at the top of the file to display the most recent updates first. diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 19ce0787ad..443cdb7264 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -285,6 +285,14 @@ When an unauthenticated user tries to access a protected page, the redirect to y +### Test your configuration + +Before you share the URL with users, verify that authentication works as expected: + +- **Preview deployments**: [Preview deployments](/deploy/preview-deployments) respect the same authentication settings as your production site. Push a branch and open the preview URL to confirm the login flow works end to end. +- **Test with a real account**: Sign in with a test user or a member of each group that should have access, and confirm that restricted pages appear or hide as expected. +- **Local development**: `mint dev` serves your site without enforcing authentication so you can iterate on content. Always confirm access rules against a preview or production deployment, not the local server. + ## Make pages public When using authentication, all pages require authentication to access by default. You can make specific pages viewable without authentication at the page or group level with the `public` property. diff --git a/deploy/export.mdx b/deploy/export.mdx index f8d8933eaf..5bfeb3df06 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -65,6 +65,15 @@ The exported archive contains everything needed to view your docs offline: | `Start Docs.command` | macOS launcher—double-click to open the docs | | `Start Docs.bat` | Windows launcher—double-click to open the docs | +### Feature support + +The exported archive is a static bundle, so features that depend on Mintlify's cloud services are not available offline: + +- **Supported offline**: Page navigation, images, code samples, Mermaid diagrams, and other pre-rendered content. +- **Not supported offline**: Full-text search, the AI assistant, the interactive API playground, analytics, feedback widgets, and authentication. + +Recipients who need these features must access your live site. + ## View the exported docs Share the zip file with anyone who has Node.js installed. To view the docs: diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx index 288f5d155f..6bc5d47d5c 100644 --- a/editor/branching-and-publishing.mdx +++ b/editor/branching-and-publishing.mdx @@ -159,7 +159,21 @@ When you publish, you can enter a commit message before confirming. If you leave 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. +The editor displays a warning when conflicts block publishing. To resolve them: + +1. Open the conflict warning in the publish menu to see the list of conflicting files. +2. Click a file to open it. The editor shows your changes alongside the incoming changes from the deployment branch. +3. For each conflict, choose **Keep mine**, **Keep theirs**, or edit the section manually to combine both. +4. Save the file to clear the conflict, then publish again. + +## Revert a published change + +To undo a change after it has been published, revert the commit in your Git provider: + +- **GitHub**: Open the merged pull request or the commit in the repository and click **Revert**. Merge the revert pull request to publish the rollback. +- **GitLab**: Open the merge request or commit and click **Revert**. Merge the resulting revert commit. + +The editor syncs the revert automatically, and your live site redeploys with the previous content. ## Collaborate in real time diff --git a/es/agent/index.mdx b/es/agent/index.mdx index 0e7d4be076..a70525495b 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -18,6 +18,24 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal. +
+ ## Empezar +
+ +1. Abre la página [Agent](https://app.mintlify.com/products/agent) en tu dashboard. +2. Instala la aplicación de GitHub de Mintlify en los repositorios con los que quieras que trabaje el agente. +3. Envía tu primera solicitud desde el panel del agente, desde Slack o abriendo una pull request en un repositorio conectado. +4. Revisa la pull request que abre el agente y fusiónala cuando estés listo. + +
+ ## Cómo el agente se mantiene seguro +
+ +- Solo abre pull requests. El agente nunca realiza commits directamente en tu branch de despliegue. +- Solo accede a los repositorios que conectes a través de la aplicación de GitHub de Mintlify. +- Trata los repositorios que no son de documentación como de solo lectura, usándolos como contexto pero sin escribir en ellos. +- Requiere revisión humana y fusión antes de que cualquier cambio llegue a tu sitio en vivo. +
## Qué puedes hacer con el agente
diff --git a/es/agent/slack.mdx b/es/agent/slack.mdx index 5681866445..d096370128 100644 --- a/es/agent/slack.mdx +++ b/es/agent/slack.mdx @@ -50,6 +50,17 @@ Si necesitas volver a autorizar el agente —por ejemplo, para otorgarle nuevos Cuando reinstalas el agente en un espacio de trabajo que ya está conectado a tu organización, Mintlify actualiza en su lugar el bot token almacenado. Tus canales e hilos existentes se conservan intactos. +
+ ### Desconectar el agente +
+ +Para eliminar el agente de tu espacio de trabajo de Slack: + +1. En Slack, ve a **Settings & administration > Manage apps** y abre la app `mintlify`. +2. Haz clic en **Remove app** para desinstalarla del espacio de trabajo. + +Después de eliminarla, el agente deja de responder a menciones y mensajes directos. El historial de hilos existente permanece en Slack, pero el agente no puede acceder a él. Reinstala la app desde tu panel de Mintlify para volver a conectarla. + Si tu organización tiene múltiples despliegues, el agente te pide que elijas con cuál despliegue trabajar la primera vez que envías una solicitud. @@ -66,8 +77,8 @@ conversación para que puedas continuar donde lo dejaste con el nuevo despliegue Una vez conectado, puedes: -- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación. -- Mencionar `@mintlify` en un canal para usarlo de forma pública y colaborativa. +- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación. Los mensajes directos funcionan en cuanto la app esté instalada. +- Mencionar `@mintlify` en un canal para usarlo de forma pública y colaborativa. El agente solo responde en los canales a los que ha sido invitado; ejecuta `/invite @mintlify` en un canal para añadirlo. - Adjuntar archivos e imágenes directamente a tus mensajes para que el agente los procese y los incluya en tu documentación. - Continuar las conversaciones en hilos para iterar sobre los cambios o hacer preguntas de seguimiento. El agente reutiliza los archivos, las imágenes y las reacciones con emoji compartidos previamente en el hilo como contexto para las solicitudes posteriores, por lo que no es necesario que los vuelvas a cargar. - Compartir enlaces a solicitudes de extracción con el agente para actualizar la documentación relacionada. diff --git a/es/automations/manage.mdx b/es/automations/manage.mdx index 11167e0ee3..682f0987ec 100644 --- a/es/automations/manage.mdx +++ b/es/automations/manage.mdx @@ -176,6 +176,21 @@ Cada ejecución muestra uno de los siguientes estados: Haz clic en una ejecución individual para ver su prompt, los archivos que leyó o modificó y cualquier pull request que haya abierto. +
+### Solucionar una ejecución fallida +
+ +Si una ejecución muestra el estado **Failed**, ábrela desde la página [Automation Runs](https://app.mintlify.com/products/automations) para ver el prompt del agente, las llamadas a herramientas y la salida de error. + +Causas comunes: + +- Falta de acceso a un repositorio de contexto o de código fuente. Reinstala la [aplicación de GitHub de Mintlify](/es/deploy/github) en el repositorio afectado. +- Un token de integración revocado. Reconecta la integración en la página [Integraciones](https://app.mintlify.com/settings/organization/integrations). +- Un `docs.json` inválido o un error de validación en el repositorio del proyecto. +- Una programación o un activador que se dispara antes de que finalice la ejecución anterior. + +Después de resolver el problema subyacente, haz clic en el botón de ejecución junto a la automatización para volver a intentarlo. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones, por lo que los reintentos son seguros. +
## Continuar una ejecución en el editor
diff --git a/es/automations/reference.mdx b/es/automations/reference.mdx index 1a3e076c55..af55f91dd6 100644 --- a/es/automations/reference.mdx +++ b/es/automations/reference.mdx @@ -6,6 +6,8 @@ keywords: ["predefinida", "automatización", "predeterminada"] Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de documentación más comunes. Cada automatización tiene un prompt base y una configuración predeterminada. Puedes personalizar el activador, el modo de actualización y las instrucciones desde la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +Si ninguna de las automatizaciones predefinidas se ajusta a tu caso de uso, consulta [Crear una automatización personalizada](/es/automations/create) para definir tu propio prompt, activador y repositorios de contexto. +
## De un vistazo
diff --git a/es/create/changelogs.mdx b/es/create/changelogs.mdx index f73bbefa89..09502d4ee9 100644 --- a/es/create/changelogs.mdx +++ b/es/create/changelogs.mdx @@ -23,6 +23,8 @@ Consulta el [registro de cambios de Mintlify](/es/changelog) como ejemplo: en ca Añade un `Update` para cada entrada del registro. Incluye información relevante como lanzamientos de funcionalidades, correcciones de errores u otros anuncios. + + Las entradas aparecen en el orden en que las listes en el archivo. Añade las nuevas entradas al principio del archivo para mostrar primero las actualizaciones más recientes. diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index f8c427f428..faf9134597 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -302,6 +302,16 @@ Usa esta comparación para elegir el método que se adapte a tu caso de uso. Con +
+ ### Prueba tu configuración +
+ +Antes de compartir la URL con los usuarios, verifica que la autenticación funcione como se espera: + +- **Preview deployments**: Los [preview deployments](/es/deploy/preview-deployments) respetan la misma configuración de autenticación que tu sitio de producción. Envía una rama y abre la URL de vista previa para confirmar que el flujo de inicio de sesión funciona de principio a fin. +- **Prueba con una cuenta real**: Inicia sesión con un usuario de prueba o con un miembro de cada grupo que deba tener acceso, y confirma que las páginas restringidas aparecen o se ocultan como corresponde. +- **Desarrollo local**: `mint dev` sirve tu sitio sin aplicar la autenticación para que puedas iterar sobre el contenido. Verifica siempre las reglas de acceso contra un preview o un despliegue de producción, no contra el servidor local. +
## Hacer públicas las páginas
diff --git a/es/deploy/export.mdx b/es/deploy/export.mdx index 86797e1012..457a6706ec 100644 --- a/es/deploy/export.mdx +++ b/es/deploy/export.mdx @@ -75,6 +75,17 @@ El archivo exportado contiene todo lo necesario para ver tu documentación sin c | `Start Docs.command` | Lanzador para macOS—haz doble clic para abrir la documentación | | `Start Docs.bat` | Lanzador para Windows—haz doble clic para abrir la documentación | +
+ ### Compatibilidad de funciones +
+ +El archivo exportado es un paquete estático, por lo que las funciones que dependen de los servicios en la nube de Mintlify no están disponibles sin conexión: + +- **Compatible sin conexión**: Navegación por páginas, imágenes, ejemplos de código, diagramas Mermaid y otro contenido pre-renderizado. +- **No compatible sin conexión**: Búsqueda de texto completo, el asistente de IA, el playground interactivo de la API, la analítica, los widgets de comentarios y la autenticación. + +Los destinatarios que necesiten estas funciones deben acceder a tu sitio en producción. +
## Ver la documentación exportada
diff --git a/es/editor/branching-and-publishing.mdx b/es/editor/branching-and-publishing.mdx index f82b20c2ea..8f63103d0a 100644 --- a/es/editor/branching-and-publishing.mdx +++ b/es/editor/branching-and-publishing.mdx @@ -227,7 +227,25 @@ Al publicar, puede introducir un mensaje de commit antes de confirmar. Si lo dej 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. +El editor muestra una advertencia cuando los conflictos bloquean la publicación. Para resolverlos: + +1. Abra la advertencia de conflictos en el menú de publicación para ver la lista de archivos en conflicto. +2. Haga clic en un archivo para abrirlo. El editor muestra sus cambios junto a los cambios entrantes de la deployment branch. +3. Para cada conflicto, elija **Keep mine**, **Keep theirs**, o edite la sección manualmente para combinar ambos. +4. Guarde el archivo para eliminar el conflicto y vuelva a publicar. + +
+ +## Revertir un cambio publicado + +
+ +Para deshacer un cambio después de haberlo publicado, revierta el commit en su proveedor de Git: + +- **GitHub**: Abra la pull request fusionada o el commit en el repositorio y haga clic en **Revert**. Fusione la pull request de revert para publicar la reversión. +- **GitLab**: Abra la merge request o el commit y haga clic en **Revert**. Fusione el commit de revert resultante. + +El editor sincroniza el revert automáticamente y su sitio en vivo se vuelve a desplegar con el contenido anterior.
diff --git a/es/optimize/feedback.mdx b/es/optimize/feedback.mdx index 01f699b842..16778917be 100644 --- a/es/optimize/feedback.mdx +++ b/es/optimize/feedback.mdx @@ -26,6 +26,29 @@ Consulta los comentarios en la página de Analytics en tu dashboard. /> +
+ ## Habilitar comentarios +
+ +1. Ve a la página [Add-ons](https://app.mintlify.com/products/addons) en tu dashboard. +2. Activa los tipos de comentarios que quieras recopilar. +3. Guarda los cambios. + +Después de habilitar los comentarios, los widgets correspondientes aparecen en tu sitio publicado y los envíos empiezan a llegar a la pestaña de comentarios. + +
+ ## Cómo envían comentarios los lectores +
+ +Los lectores envían comentarios directamente en tu sitio publicado: + +- **Valoración con pulgares**: Los botones de pulgar arriba y pulgar abajo aparecen al final de cada página. +- **Comentarios contextuales**: Los lectores abren el menú contextual en una página para dejar comentarios de texto libre. +- **Comentarios sobre fragmentos de código**: Los lectores pasan el cursor sobre un bloque de código para reaccionar o comentar sobre el fragmento. +- **Sugerir ediciones y crear issues**: Los enlaces desde la página abren una pull request o un issue precompletado en tu repositorio de GitHub. + +Los envíos aparecen en el [dashboard de comentarios](https://app.mintlify.com/products/analytics/v2/feedback) en cuanto se reciben. +
## Tipos de comentarios
diff --git a/es/optimize/pdf-exports.mdx b/es/optimize/pdf-exports.mdx index 2d5e8e3943..e21d6126dd 100644 --- a/es/optimize/pdf-exports.mdx +++ b/es/optimize/pdf-exports.mdx @@ -55,3 +55,9 @@ Las exportaciones en PDF de todo el sitio incluyen todas las páginas independie - **Language**: Si tu contenido está disponible en varios idiomas, elige el idioma que quieres exportar. 5. Selecciona **Export**. 6. Cuando se complete la exportación, Mintlify te envía un correo electrónico con un enlace para descargar el archivo PDF. + + + Las exportaciones normalmente tardan unos minutos para sitios pequeños y más para sitios grandes. Si no recibes el correo electrónico, consulta la página [Exports](https://app.mintlify.com/settings/deployment/export-docs) en tu dashboard para volver a descargar exportaciones anteriores o reintentar una exportación fallida. + + Las exportaciones en PDF se activan manualmente desde el dashboard. No hay una opción de API ni de exportación programada. + diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index 834133abc3..3b03e725f7 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -18,6 +18,24 @@ L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec Tous les changements passent par des pull requests (demandes de fusion). L'agent ne fait jamais de commit directement sur votre branche principale. +
+ ## Démarrer +
+ +1. Ouvrez la page [Agent](https://app.mintlify.com/products/agent) dans votre dashboard. +2. Installez la GitHub App Mintlify sur les dépôts avec lesquels vous souhaitez que l'agent travaille. +3. Envoyez votre première requête depuis le panneau de l'agent, depuis Slack, ou en ouvrant une pull request dans un dépôt connecté. +4. Relisez la pull request ouverte par l'agent et fusionnez-la lorsque vous êtes prêt. + +
+ ## Comment l'agent reste sûr +
+ +- N'ouvre que des pull requests. L'agent ne fait jamais de commit directement sur votre branche de déploiement. +- N'accède qu'aux dépôts que vous connectez via la GitHub App Mintlify. +- Traite les dépôts qui ne sont pas de documentation en lecture seule, en les utilisant comme contexte sans jamais y écrire. +- Nécessite une relecture et une fusion humaines avant qu'un changement n'atteigne votre site en production. +
## Ce que vous pouvez faire avec l’agent
diff --git a/fr/agent/slack.mdx b/fr/agent/slack.mdx index a836f55cb6..32d4b276e7 100644 --- a/fr/agent/slack.mdx +++ b/fr/agent/slack.mdx @@ -50,6 +50,17 @@ Si vous devez réautoriser l'agent — par exemple, pour accorder de nouvelles p Lorsque vous réinstallez l'agent dans un espace de travail déjà connecté à votre organisation, Mintlify met à jour le bot token stocké sur place. Vos canaux et fils de discussion existants restent intacts. +
+ ### Déconnecter l'agent +
+ +Pour supprimer l'agent de votre espace de travail Slack : + +1. Dans Slack, accédez à **Settings & administration > Manage apps** et ouvrez l'application `mintlify`. +2. Cliquez sur **Remove app** pour la désinstaller de l'espace de travail. + +Après la suppression, l'agent cesse de répondre aux mentions et aux messages directs. L'historique des fils existants reste dans Slack, mais l'agent ne peut plus y accéder. Réinstallez l'application depuis votre dashboard Mintlify pour vous reconnecter. + Si votre organisation dispose de plusieurs déploiements, l'agent vous demande de choisir avec quel déploiement travailler la première fois que vous envoyez une demande. @@ -67,8 +78,8 @@ déploiement. Une fois connecté, vous pouvez : -- Envoyer des messages directs à l'agent pour l'utiliser en privé afin de mettre à jour votre documentation. -- Mentionner `@mintlify` dans un canal pour l'utiliser publiquement et de manière collaborative. +- Envoyer des messages directs à l'agent pour l'utiliser en privé afin de mettre à jour votre documentation. Les messages directs fonctionnent dès que l'application est installée. +- Mentionner `@mintlify` dans un canal pour l'utiliser publiquement et de manière collaborative. L'agent ne répond que dans les canaux auxquels il a été invité — exécutez `/invite @mintlify` dans un canal pour l'ajouter. - Joindre des fichiers et des images directement à vos messages pour que l'agent les analyse et les intègre à votre documentation. - Poursuivre les conversations dans des fils pour affiner les modifications ou poser des questions de suivi. L'agent réutilise les fichiers, images et réactions emoji partagés plus tôt dans le fil comme contexte pour les demandes suivantes, vous n'avez donc pas besoin de les téléverser à nouveau. - Partager des liens de pull request (demandes de fusion) avec l'agent pour mettre à jour la documentation associée. diff --git a/fr/automations/manage.mdx b/fr/automations/manage.mdx index 3c0bc7b111..0d562761c8 100644 --- a/fr/automations/manage.mdx +++ b/fr/automations/manage.mdx @@ -176,6 +176,21 @@ Chaque exécution affiche l'un des statuts suivants : Cliquez sur une exécution individuelle pour voir son prompt, les fichiers qu'elle a lus ou modifiés, et toute pull request qu'elle a ouverte. +
+ ### Dépanner une exécution en échec +
+ +Si une exécution affiche le statut **Failed**, ouvrez-la depuis la page [Automation Runs](https://app.mintlify.com/products/automations) pour voir le prompt de l'agent, les appels d'outils et la sortie d'erreur. + +Causes courantes : + +- Absence d'accès à un dépôt de contexte ou de code source. Réinstallez la [GitHub App Mintlify](/fr/deploy/github) sur le dépôt concerné. +- Un jeton d'intégration révoqué. Reconnectez l'intégration sur la page [Integrations](https://app.mintlify.com/settings/organization/integrations). +- Un `docs.json` invalide ou une erreur de validation dans le dépôt du projet. +- Un calendrier ou un déclencheur qui se déclenche avant la fin de l'exécution précédente. + +Après avoir résolu le problème sous-jacent, cliquez sur le bouton d'exécution à côté de l'automatisation pour la relancer. Les exécutions en échec ne comptent pas dans votre limite quotidienne d'exécutions, les relances sont donc sans risque. +
## Poursuivre une exécution dans l'éditeur
diff --git a/fr/automations/reference.mdx b/fr/automations/reference.mdx index 398f70b69a..bbd15388f4 100644 --- a/fr/automations/reference.mdx +++ b/fr/automations/reference.mdx @@ -6,6 +6,8 @@ keywords: ["predefined", "automation", "default"] Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de documentation les plus courantes. Chaque automatisation possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le déclencheur, le mode de mise à jour et les instructions depuis la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. +Si aucune des automatisations prédéfinies ne correspond à votre cas d'usage, consultez [Créer une automatisation personnalisée](/fr/automations/create) pour définir votre propre prompt, déclencheur et dépôts de contexte. +
## En un coup d'œil
diff --git a/fr/create/changelogs.mdx b/fr/create/changelogs.mdx index 76b1c144d9..863f787dc4 100644 --- a/fr/create/changelogs.mdx +++ b/fr/create/changelogs.mdx @@ -23,6 +23,8 @@ Consultez le [journal des modifications de Mintlify](/fr/changelog) comme exempl Ajoutez un `Update` pour chaque entrée du journal des modifications. Incluez des informations pertinentes comme des sorties de nouvelles fonctionnalités, des correctifs de bugs ou d'autres annonces. + + Les entrées apparaissent dans l'ordre où vous les listez dans le fichier. Ajoutez les nouvelles entrées en haut du fichier pour afficher les mises à jour les plus récentes en premier. diff --git a/fr/deploy/authentication-setup.mdx b/fr/deploy/authentication-setup.mdx index ea6c1f87eb..65baf6b678 100644 --- a/fr/deploy/authentication-setup.mdx +++ b/fr/deploy/authentication-setup.mdx @@ -302,6 +302,16 @@ Utilisez ce comparatif pour choisir la méthode adaptée à votre cas d'usage. C +
+ ### Tester votre configuration +
+ +Avant de partager l'URL avec les utilisateurs, vérifiez que l'authentification fonctionne comme prévu : + +- **Déploiements de prévisualisation** : Les [déploiements de prévisualisation](/fr/deploy/preview-deployments) respectent les mêmes paramètres d'authentification que votre site de production. Poussez une branche et ouvrez l'URL de prévisualisation pour confirmer que le flux de connexion fonctionne de bout en bout. +- **Tester avec un compte réel** : Connectez-vous avec un utilisateur de test ou un membre de chaque groupe qui devrait avoir accès, et vérifiez que les pages restreintes apparaissent ou sont masquées comme prévu. +- **Développement local** : `mint dev` sert votre site sans appliquer l'authentification pour vous permettre d'itérer sur le contenu. Vérifiez toujours les règles d'accès sur un déploiement de prévisualisation ou de production, et non sur le serveur local. +
## Rendre des pages publiques
diff --git a/fr/deploy/export.mdx b/fr/deploy/export.mdx index fdf72d7c4e..26c2557393 100644 --- a/fr/deploy/export.mdx +++ b/fr/deploy/export.mdx @@ -75,6 +75,17 @@ L'archive exportée contient tout le nécessaire pour consulter votre documentat | `Start Docs.command` | Lanceur macOS—double-cliquez pour ouvrir la documentation | | `Start Docs.bat` | Lanceur Windows—double-cliquez pour ouvrir la documentation | +
+ ### Fonctionnalités prises en charge +
+ +L'archive exportée est un bundle statique, les fonctionnalités qui dépendent des services cloud de Mintlify ne sont donc pas disponibles hors ligne : + +- **Pris en charge hors ligne** : Navigation entre les pages, images, exemples de code, diagrammes Mermaid et autres contenus pré-rendus. +- **Non pris en charge hors ligne** : Recherche en texte intégral, assistant IA, playground API interactif, analyse, widgets de retours et authentification. + +Les destinataires qui ont besoin de ces fonctionnalités doivent accéder à votre site en production. +
## Consulter la documentation exportée
diff --git a/fr/editor/branching-and-publishing.mdx b/fr/editor/branching-and-publishing.mdx index d78a8488bc..2871e712c9 100644 --- a/fr/editor/branching-and-publishing.mdx +++ b/fr/editor/branching-and-publishing.mdx @@ -227,7 +227,25 @@ Lorsque vous publiez, vous pouvez saisir un message de commit avant de confirmer Des conflits surviennent lorsque votre branche et la branche de déploiement comportent des modifications incompatibles dans les mêmes fichiers. Par exemple, lorsque vous et un coéquipier avez modifié les mêmes lignes d'un fichier ou déplacé un fichier vers des emplacements différents. -L'éditeur affiche un avertissement lorsque des conflits bloquent la publication. Suivez les invites pour choisir quelle version de chaque section en conflit conserver. +L'éditeur affiche un avertissement lorsque des conflits bloquent la publication. Pour les résoudre : + +1. Ouvrez l'avertissement de conflit dans le menu de publication pour voir la liste des fichiers en conflit. +2. Cliquez sur un fichier pour l'ouvrir. L'éditeur affiche vos modifications aux côtés des modifications entrantes de la branche de déploiement. +3. Pour chaque conflit, choisissez **Keep mine**, **Keep theirs**, ou modifiez la section manuellement pour combiner les deux. +4. Enregistrez le fichier pour effacer le conflit, puis publiez à nouveau. + +
+ +## Annuler une modification publiée + +
+ +Pour annuler une modification après sa publication, revenez sur le commit dans votre fournisseur Git : + +- **GitHub** : Ouvrez la pull request fusionnée ou le commit dans le référentiel et cliquez sur **Revert**. Fusionnez la pull request d'annulation pour publier le rollback. +- **GitLab** : Ouvrez la merge request ou le commit et cliquez sur **Revert**. Fusionnez le commit d'annulation résultant. + +L'éditeur synchronise automatiquement l'annulation, et votre site en production se redéploie avec le contenu précédent.
diff --git a/fr/optimize/feedback.mdx b/fr/optimize/feedback.mdx index 58e7ead783..2de4a83b4c 100644 --- a/fr/optimize/feedback.mdx +++ b/fr/optimize/feedback.mdx @@ -27,6 +27,29 @@ Consultez les commentaires sur la page Analytics de votre Dashboard. /> +
+ ## Activer les commentaires +
+ +1. Accédez à la page [Add-ons](https://app.mintlify.com/products/addons) de votre dashboard. +2. Activez les types de commentaires que vous souhaitez collecter. +3. Enregistrez vos modifications. + +Une fois les commentaires activés, les widgets correspondants apparaissent sur votre site publié et les soumissions commencent à alimenter l'onglet feedback. + +
+ ## Comment les lecteurs envoient des commentaires +
+ +Les lecteurs envoient des commentaires directement depuis votre site publié : + +- **Évaluation par pouces** : Des boutons pouce levé et pouce baissé apparaissent en bas de chaque page. +- **Feedback contextuel** : Les lecteurs ouvrent le menu contextuel d'une page pour laisser des commentaires libres. +- **Feedback sur les extraits de code** : Les lecteurs survolent un bloc de code pour réagir ou commenter l'extrait. +- **Suggestions de modification et création d'issues** : Les liens depuis la page ouvrent une pull request ou une issue pré-remplie dans votre référentiel GitHub. + +Les soumissions apparaissent dans le [dashboard de feedback](https://app.mintlify.com/products/analytics/v2/feedback) dès leur réception. +
## Types de feedback
diff --git a/fr/optimize/pdf-exports.mdx b/fr/optimize/pdf-exports.mdx index 77de9dc3c9..f9b6e86886 100644 --- a/fr/optimize/pdf-exports.mdx +++ b/fr/optimize/pdf-exports.mdx @@ -55,3 +55,9 @@ Les exportations PDF de l’intégralité du site incluent toutes les pages, que - **Language** : si votre contenu est disponible en plusieurs langues, choisissez la langue à exporter. 5. Cliquez sur **Export**. 6. Une fois l’export terminé, Mintlify vous envoie un e‑mail avec un lien pour télécharger le fichier PDF. + + + Les exports prennent généralement quelques minutes pour les petits sites et plus de temps pour les grands sites. Si vous ne recevez pas l'e-mail, consultez la page [Exports](https://app.mintlify.com/settings/deployment/export-docs) de votre dashboard pour retélécharger les exports précédents ou relancer un export en échec. + + Les exports PDF sont déclenchés manuellement depuis le dashboard. Il n'existe pas d'option d'export via API ni d'export planifié. + diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 78c9d3e3c8..3f3c965218 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -27,6 +27,25 @@ View feedback on the analytics page in your dashboard. /> +## Enable feedback + +1. Navigate to the [Add-ons](https://app.mintlify.com/products/addons) page in your dashboard. +2. Toggle on the feedback types you want to collect. +3. Save your changes. + +After you enable feedback, the corresponding widgets appear on your published site and submissions start flowing into the feedback tab. + +## How readers submit feedback + +Readers submit feedback directly on your published site: + +- **Thumbs rating**: Thumbs up and thumbs down buttons appear at the bottom of each page. +- **Contextual feedback**: Readers open the contextual menu on a page to leave free-form comments. +- **Code snippet feedback**: Readers hover over a code block to react to or comment on the snippet. +- **Edit suggestions and raise issues**: Links from the page open a pre-filled pull request or issue in your GitHub repository. + +Submissions appear in the [feedback dashboard](https://app.mintlify.com/products/analytics/v2/feedback) as soon as they're received. + ## Feedback types diff --git a/optimize/pdf-exports.mdx b/optimize/pdf-exports.mdx index 76cb4ddb68..7a31478cc7 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -51,3 +51,9 @@ Full-site PDF exports include all pages regardless of group restrictions, so any - **Language**: If your content is available in multiple languages, choose which language to export. 5. Click **Export**. 6. When the export completes, Mintlify sends you an email with a link to download the PDF file. + + + Exports typically take a few minutes for small sites and longer for large sites. If you don't receive the email, check the [Exports](https://app.mintlify.com/settings/deployment/export-docs) page in your dashboard to re-download previous exports or retry a failed export. + + PDF exports are triggered manually from the dashboard. There is no API or scheduled export option. + diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index bece59c164..86455590a7 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -18,6 +18,24 @@ agent 是一款 AI 工具,会根据你的提示,为文档创建包含建议 所有更改都会通过拉取请求完成。agent 永远不会直接向你的主 branch 进行提交。 +
+ ## 开始使用 +
+ +1. 在控制台中打开 [Agent](https://app.mintlify.com/products/agent) 页面。 +2. 在你希望 agent 处理的仓库上安装 Mintlify GitHub App。 +3. 通过 agent 面板、Slack,或在已连接的仓库中打开一个 pull request,发送你的第一个请求。 +4. 审核 agent 打开的 pull request,并在准备就绪时合并它。 + +
+ ## agent 如何保持安全 +
+ +- 仅打开 pull request。agent 永远不会直接向你的部署 branch 进行 commit。 +- 只访问你通过 Mintlify GitHub App 连接的仓库。 +- 将非文档仓库视为只读,仅用于获取上下文,绝不向其写入。 +- 在任何更改进入你的正式站点之前,都需要人工审核并合并。 +
## 你可以用智能助手做什么
diff --git a/zh/agent/slack.mdx b/zh/agent/slack.mdx index d927932c44..05a4fede47 100644 --- a/zh/agent/slack.mdx +++ b/zh/agent/slack.mdx @@ -42,6 +42,17 @@ keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", " 当你将 agent 重新安装到已经连接到你组织的工作区时,Mintlify 会原地刷新已存储的 bot token。你现有的频道和线程都会保持不变。 +
+ ### 断开 agent 的连接 +
+ +若要从你的 Slack 工作区中移除 agent: + +1. 在 Slack 中,进入 **Settings & administration > Manage apps**,并打开 `mintlify` 应用。 +2. 点击 **Remove app** 将其从工作区卸载。 + +移除后,agent 将不再响应提及和私信。现有的线程历史记录仍会保留在 Slack 中,但 agent 无法再访问它们。若要重新连接,请从你的 Mintlify dashboard 重新安装该应用。 + 如果你的组织有多个部署,agent 会在你首次发送请求时要求你选择要使用的部署。 @@ -55,8 +66,8 @@ keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", " 连接完成后,你可以: -- 向智能体发送私信,在私密环境中使用它来更新文档。 -- 在频道中提及 `@mintlify`,在公开场景中与团队协作使用它。 +- 向智能体发送私信,在私密环境中使用它来更新文档。应用安装完成后,即可立即使用私信功能。 +- 在频道中提及 `@mintlify`,在公开场景中与团队协作使用它。agent 只会在被邀请加入的频道中响应——在频道中运行 `/invite @mintlify` 即可将其添加进来。 - 在消息中直接附加文件和图片,让智能体处理并将其纳入文档。 - 在线程中继续对话,对修改内容持续迭代或提出后续问题。智能体会将该线程中先前共享的文件和图片作为后续请求的上下文重复使用,因此你无需再次上传。 - 将拉取请求(PR;亦称"合并请求"/Merge Request)链接分享给智能体,以更新相关文档。 diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx index 73ad261b6e..e7c184cc6d 100644 --- a/zh/automations/manage.mdx +++ b/zh/automations/manage.mdx @@ -176,6 +176,21 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; 点击单次运行即可查看其提示词、读取或更改的文件,以及它打开的任何 pull request。 +
+ ### 排查失败的运行 +
+ +如果某次运行显示 **Failed** 状态,请在 [Automation Runs](https://app.mintlify.com/products/automations) 页面打开它,查看 agent 的提示词、工具调用和错误输出。 + +常见原因: + +- 缺少对上下文或源代码仓库的访问权限。请在受影响的仓库上重新安装 [Mintlify GitHub App](/zh/deploy/github)。 +- 集成 token 已被撤销。请在 [Integrations](https://app.mintlify.com/settings/organization/integrations) 页面重新连接该集成。 +- 项目仓库中的 `docs.json` 无效或存在校验错误。 +- 计划或触发器在上一次运行完成前就再次触发。 + +在处理完根本原因后,点击该自动化旁边的 运行按钮进行重试。失败的运行不会计入你的每日运行限制,因此重试是安全的。 +
## 在编辑器中继续运行
diff --git a/zh/automations/reference.mdx b/zh/automations/reference.mdx index 7ddc57ed36..8c2055afc0 100644 --- a/zh/automations/reference.mdx +++ b/zh/automations/reference.mdx @@ -6,6 +6,8 @@ keywords: ["predefined", "automation", "default"] Mintlify 为最常见的文档维护任务提供了预定义自动化。每个自动化都有一个基础提示词和默认配置。你可以在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面自定义触发器、更新模式和指令。 +如果没有预定义自动化能满足你的场景,请参见[创建自定义自动化](/zh/automations/create),自行定义提示词、触发器和上下文仓库。 +
## 一览
diff --git a/zh/create/changelogs.mdx b/zh/create/changelogs.mdx index 26db3e00af..a01205e786 100644 --- a/zh/create/changelogs.mdx +++ b/zh/create/changelogs.mdx @@ -23,6 +23,8 @@ boost: 3 为每条更新日志记录添加一个 `Update`。 包含相关信息,例如功能发布、错误修复或其他公告。 + + 条目会按你在文件中列出的顺序显示。将新条目添加到文件顶部,以便最先展示最近的更新。 diff --git a/zh/deploy/authentication-setup.mdx b/zh/deploy/authentication-setup.mdx index 626bc59140..82743b8bef 100644 --- a/zh/deploy/authentication-setup.mdx +++ b/zh/deploy/authentication-setup.mdx @@ -302,6 +302,16 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password', 'private'] +
+ ### 测试你的配置 +
+ +在将 URL 分享给用户之前,请先验证认证是否按预期工作: + +- **Preview deployments**:[Preview deployments](/zh/deploy/preview-deployments) 使用与生产站点相同的认证设置。推送一个 branch 并打开预览 URL,即可确认登录流程能端到端正常工作。 +- **使用真实账号测试**:使用测试用户或每个应有访问权限的用户组中的成员登录,确认受限页面按预期显示或隐藏。 +- **本地开发**:`mint dev` 在提供服务时不会强制执行认证,方便你迭代内容。请始终针对预览或生产部署(而不是本地服务器)来确认访问规则。 +
## 公开页面
diff --git a/zh/deploy/export.mdx b/zh/deploy/export.mdx index 0ab7b06edf..11f2b59811 100644 --- a/zh/deploy/export.mdx +++ b/zh/deploy/export.mdx @@ -75,6 +75,17 @@ mint export --output customer-docs.zip --groups enterprise | `Start Docs.command` | macOS 启动器—双击即可打开文档 | | `Start Docs.bat` | Windows 启动器—双击即可打开文档 | +
+ ### 功能支持 +
+ +导出的归档是一个静态包,因此依赖 Mintlify 云服务的功能在离线状态下无法使用: + +- **离线支持**:页面导航、图片、代码示例、Mermaid 图表以及其他预渲染的内容。 +- **离线不支持**:全文搜索、AI 助手、交互式 API playground、分析、反馈组件和认证。 + +需要使用这些功能的收件人必须访问你的正式站点。 +
## 查看导出的文档
diff --git a/zh/editor/branching-and-publishing.mdx b/zh/editor/branching-and-publishing.mdx index 1f512acbba..a54bfee536 100644 --- a/zh/editor/branching-and-publishing.mdx +++ b/zh/editor/branching-and-publishing.mdx @@ -193,7 +193,23 @@ https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} 当你的分支和部署用分支对同一文件有不兼容的更改时,就会发生冲突。例如,你和团队成员编辑了同一文件中的同一行,或将文件移动到了不同位置。 -当冲突阻止发布时,编辑器会显示警告。按照提示选择保留每个冲突部分中的哪个版本。 +当冲突阻止发布时,编辑器会显示警告。要解决这些冲突: + +1. 在发布菜单中打开冲突警告,查看冲突文件列表。 +2. 点击某个文件将其打开。编辑器会将你的更改与来自部署用分支的传入更改并排显示。 +3. 对每个冲突,选择 **Keep mine**、**Keep theirs**,或手动编辑该部分以合并两者。 +4. 保存文件以清除冲突,然后重新发布。 + +
+ ## 撤销已发布的更改 +
+ +若要在发布后撤销某项更改,请在你的 Git 服务提供商中 revert 该 commit: + +- **GitHub**:在仓库中打开已合并的 pull request 或该 commit,然后点击 **Revert**。合并生成的 revert pull request 即可发布回滚。 +- **GitLab**:打开合并请求或 commit,然后点击 **Revert**。合并生成的 revert commit。 + +编辑器会自动同步这次 revert,你的正式站点会以先前的内容重新部署。
## 实时协作 diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index 55dcb25b0b..18c51bd8dc 100644 --- a/zh/optimize/feedback.mdx +++ b/zh/optimize/feedback.mdx @@ -27,6 +27,29 @@ boost: 3 /> +
+ ## 启用反馈 +
+ +1. 前往控制台中的 [Add-ons](https://app.mintlify.com/products/addons) 页面。 +2. 打开你希望收集的反馈类型开关。 +3. 保存你的更改。 + +启用反馈后,相应的组件会出现在你已发布的站点上,用户提交的反馈会开始流入反馈标签页。 + +
+ ## 读者如何提交反馈 +
+ +读者可直接在你已发布的站点上提交反馈: + +- **点赞评分**:每个页面底部会显示点赞和点踩按钮。 +- **上下文反馈**:读者在页面上打开上下文菜单以留下自由填写的评论。 +- **代码片段反馈**:读者将鼠标悬停在代码块上,即可对该片段作出反应或发表评论。 +- **编辑建议和提交 issue**:页面上的链接会打开一个预填的 pull request 或在你的 GitHub 仓库中创建 issue。 + +提交的反馈会在收到后立即显示在[反馈控制台](https://app.mintlify.com/products/analytics/v2/feedback)中。 +
## 反馈类型
diff --git a/zh/optimize/pdf-exports.mdx b/zh/optimize/pdf-exports.mdx index 64ee9fdde3..bba5f41270 100644 --- a/zh/optimize/pdf-exports.mdx +++ b/zh/optimize/pdf-exports.mdx @@ -55,3 +55,9 @@ export const DownloadPDFButton = () => { - **Language**:如果你的内容支持多种语言,选择要导出的语言。 5. 点击 **Export**。 6. 导出完成后,Mintlify 会向你发送一封包含 PDF 文件下载链接的电子邮件。 + + + 对于小型站点,导出通常只需几分钟;大型站点则需更长时间。如果你没有收到邮件,请在控制台中查看 [Exports](https://app.mintlify.com/settings/deployment/export-docs) 页面,以重新下载先前的导出或重试失败的导出。 + + PDF 导出需要在控制台中手动触发。目前不提供 API 或计划导出选项。 +