From 78cc2fa5e22f6f1a6fd9719f4876094e8792e9d2 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 11 Aug 2026 10:11:35 +0000 Subject: [PATCH 1/2] docs: address reader-question gaps on 5 pages updated since last quality check --- automations/create.mdx | 6 ++++++ dashboard/network-access.mdx | 4 ++++ editor/tutorial.mdx | 6 ++++++ integrations/privacy/osano.mdx | 6 ++++++ migration-services/go-live-checklist.mdx | 7 +++++++ 5 files changed, 29 insertions(+) diff --git a/automations/create.mdx b/automations/create.mdx index d6a74b6a8..efa43c494 100644 --- a/automations/create.mdx +++ b/automations/create.mdx @@ -45,6 +45,12 @@ For more examples and patterns, see [Use automations](/guides/use-automations). Review the output of your custom automations to confirm they work as expected. Update your instructions to improve the results. +## Test your automation + +Trigger a manual run before relying on a schedule or event to catch issues early. Manual runs use the automation's current configuration and appear in the run history alongside scheduled runs. See [Run an automation manually](/automations/manage#run-an-automation-manually) for the steps. + +Open the run in the [Automations](https://app.mintlify.com/products/automations?tab=runs) page to review the prompt, the files the agent read or changed, and any pull request it opened. If the result isn't what you expected, edit the instructions and run it again. + ## Edit a custom automation diff --git a/dashboard/network-access.mdx b/dashboard/network-access.mdx index 61aa8e480..b3a693c67 100644 --- a/dashboard/network-access.mdx +++ b/dashboard/network-access.mdx @@ -38,6 +38,10 @@ Both IPv4 and IPv6 addresses are supported. 4. Repeat for each address or range you want to allow. 5. Enable the allowlist to begin enforcing it. +### Recover from a lockout + +If every admin is locked out of the dashboard by the allowlist, contact [support@mintlify.com](mailto:support@mintlify.com) from an email address associated with your organization. Include your organization name and the IP address you need added. Mintlify's support team can add an address or disable the allowlist so you can regain access. + ## Session lifetimes Control how long dashboard sessions stay valid before members must sign in again. You can set two independent limits: diff --git a/editor/tutorial.mdx b/editor/tutorial.mdx index 7eae45330..35c2e22ef 100644 --- a/editor/tutorial.mdx +++ b/editor/tutorial.mdx @@ -6,6 +6,12 @@ keywords: ["editor", "tutorial", "branch", "publish"] This tutorial walks you through a complete content update using the editor. You'll create a branch, make a change, share a preview for review, and publish your changes. +## Prerequisites + +- A Mintlify project connected to a GitHub, GitLab, or Bitbucket repository. See [Connect a repository](/deploy/github) for setup. +- An account with editor access to the project. If you can't sign in, ask an admin to invite you from the [Members](https://app.mintlify.com/settings/organization/members) page. +- Permission to open pull requests in the connected repository through your Git provider. + A branch is a temporary copy of your content. It's where you make your changes without affecting your live site. You can merge a branch into your live site or safely discard it if you choose not to make the changes. diff --git a/integrations/privacy/osano.mdx b/integrations/privacy/osano.mdx index 1224d0e01..f57afac8a 100644 --- a/integrations/privacy/osano.mdx +++ b/integrations/privacy/osano.mdx @@ -29,6 +29,12 @@ document.head.appendChild(script); Replace `OSANO_SCRIPT_URL` with your Osano script URL. Your script URL is the `src` value in the code snippet that Osano generates. Your script URL always starts with `https://cmp.osano.com/` and ends with `/osano.js`. +Mintlify automatically includes any `.js` file inside your content directory on every page of your site. You don't need to register `osano.js` in `docs.json`. See [Custom JavaScript](/customize/custom-scripts#custom-javascript) for details. + +## Verify the banner + +After you deploy, open your site in a private or incognito window and confirm the Osano consent banner appears. If it doesn't, check the browser console for errors loading `osano.js` and confirm the script URL matches the one from your Osano dashboard. + ## Troubleshooting Date: Tue, 11 Aug 2026 10:16:07 +0000 Subject: [PATCH 2/2] docs: mirror reader-question gap fixes into es, fr, and zh translations --- es/automations/create.mdx | 8 ++++++++ es/dashboard/network-access.mdx | 6 ++++++ es/editor/tutorial.mdx | 8 ++++++++ es/integrations/privacy/osano.mdx | 8 ++++++++ es/migration-services/go-live-checklist.mdx | 9 +++++++++ fr/automations/create.mdx | 8 ++++++++ fr/dashboard/network-access.mdx | 6 ++++++ fr/editor/tutorial.mdx | 8 ++++++++ fr/integrations/privacy/osano.mdx | 8 ++++++++ fr/migration-services/go-live-checklist.mdx | 9 +++++++++ zh/automations/create.mdx | 8 ++++++++ zh/dashboard/network-access.mdx | 6 ++++++ zh/editor/tutorial.mdx | 8 ++++++++ zh/integrations/privacy/osano.mdx | 8 ++++++++ zh/migration-services/go-live-checklist.mdx | 9 +++++++++ 15 files changed, 117 insertions(+) diff --git a/es/automations/create.mdx b/es/automations/create.mdx index db011748b..4c60293a3 100644 --- a/es/automations/create.mdx +++ b/es/automations/create.mdx @@ -49,6 +49,14 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u Revisa la salida de tus automatizaciones personalizadas para confirmar que funcionan como esperabas. Actualiza tus instrucciones para mejorar los resultados. +
+## Prueba tu automatización +
+ +Ejecuta manualmente una automatización antes de depender de un calendario o un evento para detectar problemas con antelación. Las ejecuciones manuales utilizan la configuración actual de la automatización y aparecen en el historial de ejecuciones junto con las ejecuciones programadas. Consulta [Ejecutar una automatización manualmente](/es/automations/manage#run-an-automation-manually) para conocer los pasos. + +Abre la ejecución en la página [Automatizaciones](https://app.mintlify.com/products/automations?tab=runs) para revisar el prompt, los archivos que el agente leyó o modificó, y cualquier pull request que haya abierto. Si el resultado no es el que esperabas, edita las instrucciones y vuelve a ejecutarla. +
diff --git a/es/dashboard/network-access.mdx b/es/dashboard/network-access.mdx index d6c14f5b7..6e12e21ec 100644 --- a/es/dashboard/network-access.mdx +++ b/es/dashboard/network-access.mdx @@ -42,6 +42,12 @@ Se admiten direcciones IPv4 e IPv6. 4. Repite el proceso para cada dirección o rango que quieras permitir. 5. Activa la lista de IP permitidas para empezar a aplicarla. +
+ ### Recuperarse de un bloqueo +
+ +Si todos los administradores quedan bloqueados fuera del dashboard debido a la lista de IP permitidas, ponte en contacto con [support@mintlify.com](mailto:support@mintlify.com) desde una dirección de correo electrónico asociada a tu organización. Incluye el nombre de tu organización y la dirección IP que necesitas añadir. El equipo de soporte de Mintlify puede añadir una dirección o desactivar la lista de IP permitidas para que puedas recuperar el acceso. +
## Duración de las sesiones
diff --git a/es/editor/tutorial.mdx b/es/editor/tutorial.mdx index 77bab7c1a..ace79e82f 100644 --- a/es/editor/tutorial.mdx +++ b/es/editor/tutorial.mdx @@ -6,6 +6,14 @@ keywords: ["editor", "tutorial", "branch", "publish"] Este tutorial le guía a través de una actualización completa de contenido usando el editor. Creará una branch, hará un cambio, compartirá una vista previa para su revisión y publicará sus cambios. +
+## Requisitos previos +
+ +- Un proyecto de Mintlify conectado a un repositorio de GitHub, GitLab o Bitbucket. Consulte [Conectar un repositorio](/es/deploy/github) para la configuración. +- Una cuenta con acceso de editor al proyecto. Si no puede iniciar sesión, pida a un administrador que le invite desde la página [Members](https://app.mintlify.com/settings/organization/members). +- Permiso para abrir pull requests en el repositorio conectado a través de su proveedor de Git. + Una branch es una copia temporal de su contenido. Es donde realiza sus cambios sin afectar a su sitio en producción. Puede fusionarla con su sitio en producción o descartarla de forma segura si decide no aplicar los cambios. diff --git a/es/integrations/privacy/osano.mdx b/es/integrations/privacy/osano.mdx index e0e1139d7..f7f9fd45e 100644 --- a/es/integrations/privacy/osano.mdx +++ b/es/integrations/privacy/osano.mdx @@ -29,6 +29,14 @@ Crea un archivo `osano.js` en cualquier ubicación dentro de tu directorio de co Reemplaza `OSANO_SCRIPT_URL` con la URL de tu script de Osano. La URL de tu script es el valor de `src` en el fragmento de código que genera Osano. La URL de tu script siempre comienza con `https://cmp.osano.com/` y termina con `/osano.js`. +Mintlify incluye automáticamente cualquier archivo `.js` de tu directorio de contenido en todas las páginas de tu sitio. No necesitas registrar `osano.js` en `docs.json`. Consulta [JavaScript personalizado](/es/customize/custom-scripts#custom-javascript) para más detalles. + +
+ ## Verificar el banner +
+ +Después de desplegar, abre tu sitio en una ventana privada o de incógnito y confirma que el banner de consentimiento de Osano aparece. Si no aparece, revisa la consola del navegador en busca de errores al cargar `osano.js` y confirma que la URL del script coincide con la de tu dashboard de Osano. +
## Solución de problemas
diff --git a/es/migration-services/go-live-checklist.mdx b/es/migration-services/go-live-checklist.mdx index 918e65e76..633c90bb7 100644 --- a/es/migration-services/go-live-checklist.mdx +++ b/es/migration-services/go-live-checklist.mdx @@ -50,6 +50,15 @@ Esta es una lista completa de configuraciones que debes establecer y ajustes que - **Configura las automatizaciones.** Consulta [cómo habilitar una automatización](/es/automations/manage#enable-an-automation). - **Instala los complementos de analíticas pertinentes.** Consulta la [lista de integraciones de analíticas](/es/integrations/analytics/overview). +
+ ## Validación previa al lanzamiento +
+ +- **Previsualiza el sitio en tu subdominio `.mintlify.site`.** Cada despliegue obtiene una URL alojada por Mintlify como `example.mintlify.site`. Recorre el sitio como lo haría un lector antes de apuntar tu dominio personalizado hacia él. +- **Ejecuta `mint broken-links` localmente.** Consulta la [referencia de la CLI](/es/cli/commands) para la configuración. Corrige los enlaces rotos que reporte. +- **Verifica que las redirecciones resuelvan a los destinos correctos.** Prueba cada ruta de origen contra tu URL de vista previa. +- **Confirma la autenticación y el acceso a nivel de página.** Si has configurado la autenticación, inicia sesión como un usuario de cada grupo de acceso para verificar que ven las páginas correctas. +
## Publicar el sitio
diff --git a/fr/automations/create.mdx b/fr/automations/create.mdx index e244acf9d..0a17504b3 100644 --- a/fr/automations/create.mdx +++ b/fr/automations/create.mdx @@ -49,6 +49,14 @@ Pour plus d'exemples et de modèles, consultez [Utiliser les automatisations](/f Vérifiez les résultats de vos automatisations personnalisées pour confirmer qu'elles fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats. +
+ ## Tester votre automatisation +
+ +Déclenchez une exécution manuelle avant de vous fier à un calendrier ou à un événement afin de détecter les problèmes en amont. Les exécutions manuelles utilisent la configuration actuelle de l'automatisation et apparaissent dans l'historique des exécutions aux côtés des exécutions planifiées. Consultez [Exécuter une automatisation manuellement](/fr/automations/manage#run-an-automation-manually) pour les étapes. + +Ouvrez l'exécution dans la page [Automations](https://app.mintlify.com/products/automations?tab=runs) pour examiner le prompt, les fichiers que l'agent a lus ou modifiés, ainsi que toute pull request qu'il a ouverte. Si le résultat ne correspond pas à ce que vous attendiez, modifiez les instructions et relancez l'automatisation. +
diff --git a/fr/dashboard/network-access.mdx b/fr/dashboard/network-access.mdx index f7ace10c6..7b019a176 100644 --- a/fr/dashboard/network-access.mdx +++ b/fr/dashboard/network-access.mdx @@ -42,6 +42,12 @@ Les adresses IPv4 et IPv6 sont toutes deux prises en charge. 4. Répétez pour chaque adresse ou plage que vous souhaitez autoriser. 5. Activez la liste d'autorisation pour commencer à l'appliquer. +
+ ### Récupérer l'accès après un verrouillage +
+ +Si tous les administrateurs sont verrouillés hors du dashboard par la liste d'autorisation, contactez [support@mintlify.com](mailto:support@mintlify.com) depuis une adresse e-mail associée à votre organisation. Indiquez le nom de votre organisation et l'adresse IP à ajouter. L'équipe de support de Mintlify peut ajouter une adresse ou désactiver la liste d'autorisation pour vous permettre de retrouver l'accès. +
## Durées de session
diff --git a/fr/editor/tutorial.mdx b/fr/editor/tutorial.mdx index 5d8b6c600..f8c9ff5fd 100644 --- a/fr/editor/tutorial.mdx +++ b/fr/editor/tutorial.mdx @@ -6,6 +6,14 @@ keywords: ["editor", "tutorial", "branch", "publish"] Ce tutoriel vous guide à travers une mise à jour de contenu complète avec l'éditeur. Vous allez créer une branche, faire une modification, partager un aperçu pour relecture et publier vos modifications. +
+ ## Prérequis +
+ +- Un projet Mintlify connecté à un dépôt GitHub, GitLab ou Bitbucket. Consultez [Connecter un dépôt](/fr/deploy/github) pour la configuration. +- Un compte disposant d'un accès éditeur au projet. Si vous ne parvenez pas à vous connecter, demandez à un administrateur de vous inviter depuis la page [Members](https://app.mintlify.com/settings/organization/members). +- L'autorisation d'ouvrir des pull requests dans le dépôt connecté via votre fournisseur Git. + Une branche est une copie temporaire de votre contenu. C'est là que vous effectuez vos modifications sans affecter votre site en production. Vous pouvez fusionner une branche dans votre site en production ou l'abandonner en toute sécurité si vous choisissez de ne pas appliquer les modifications. diff --git a/fr/integrations/privacy/osano.mdx b/fr/integrations/privacy/osano.mdx index 67c99ca19..3a5f1a155 100644 --- a/fr/integrations/privacy/osano.mdx +++ b/fr/integrations/privacy/osano.mdx @@ -29,6 +29,14 @@ Créez un fichier `osano.js` n'importe où dans votre répertoire de contenu ave Remplacez `OSANO_SCRIPT_URL` par l’URL de votre script Osano. Cette URL de script correspond à la valeur `src` dans l’extrait de code généré par Osano. Votre URL de script commence toujours par `https://cmp.osano.com/` et se termine par `/osano.js`. +Mintlify inclut automatiquement tout fichier `.js` de votre répertoire de contenu sur chaque page de votre site. Vous n'avez pas besoin d'enregistrer `osano.js` dans `docs.json`. Consultez [JavaScript personnalisé](/fr/customize/custom-scripts#custom-javascript) pour plus de détails. + +
+ ## Vérifier la bannière +
+ +Après le déploiement, ouvrez votre site dans une fenêtre privée ou de navigation incognito et confirmez que la bannière de consentement Osano s'affiche. Si ce n'est pas le cas, vérifiez la console du navigateur pour repérer les erreurs de chargement de `osano.js` et confirmez que l'URL du script correspond à celle indiquée dans votre dashboard Osano. +
## Dépannage
diff --git a/fr/migration-services/go-live-checklist.mdx b/fr/migration-services/go-live-checklist.mdx index 1c7826708..06491457d 100644 --- a/fr/migration-services/go-live-checklist.mdx +++ b/fr/migration-services/go-live-checklist.mdx @@ -50,6 +50,15 @@ Cette liste récapitule les configurations à mettre en place et les paramètres - **Configurez les automatisations.** Consultez [comment activer une automatisation](/fr/automations/manage#enable-an-automation). - **Installez les modules d'analyse pertinents.** Consultez la [liste des intégrations d'analyse](/fr/integrations/analytics/overview). +
+ ## Validation avant lancement +
+ +- **Prévisualisez le site sur votre sous-domaine `.mintlify.site`.** Chaque déploiement bénéficie d'une URL hébergée par Mintlify, comme `example.mintlify.site`. Parcourez le site comme le ferait un lecteur avant d'y faire pointer votre domaine personnalisé. +- **Exécutez `mint broken-links` localement.** Consultez la [référence CLI](/fr/cli/commands) pour la configuration. Corrigez tous les liens rompus qu'il signale. +- **Vérifiez que les redirections mènent aux bonnes destinations.** Testez chaque chemin source par rapport à votre URL de prévisualisation. +- **Confirmez l'authentification et l'accès au niveau des pages.** Si vous avez configuré l'authentification, connectez-vous en tant qu'utilisateur de chaque groupe d'accès pour vérifier qu'ils voient les bonnes pages. +
## Mise en ligne
diff --git a/zh/automations/create.mdx b/zh/automations/create.mdx index 47b15beaa..16711488a 100644 --- a/zh/automations/create.mdx +++ b/zh/automations/create.mdx @@ -49,6 +49,14 @@ import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; 审查你自定义自动化的输出，以确认它们按预期运行。更新你的指令以改进结果。 +
+ ## 测试你的自动化 +
+ +在依赖计划或事件触发之前先手动运行一次，可以尽早发现问题。手动运行会使用自动化的当前配置，并与计划运行一同显示在运行历史中。有关步骤，请参见[手动运行自动化](/zh/automations/manage#run-an-automation-manually)。 + +在 [Automations](https://app.mintlify.com/products/automations?tab=runs) 页面打开该次运行，查看提示词、agent 读取或更改的文件，以及它打开的任何拉取请求。如果结果与预期不符，请编辑指令并再次运行。 +
diff --git a/zh/dashboard/network-access.mdx b/zh/dashboard/network-access.mdx index e70049ffb..1a4889894 100644 --- a/zh/dashboard/network-access.mdx +++ b/zh/dashboard/network-access.mdx @@ -42,6 +42,12 @@ IP 允许列表适用于你的 Mintlify dashboard 和编辑器，包括 SSO 和 4. 对你想要允许的每个地址或范围重复此操作。 5. 启用允许列表以开始执行。 +
+ ### 从锁定中恢复 +
+ +如果允许列表将所有管理员都锁定在 dashboard 之外，请使用与你组织关联的邮箱地址联系 [support@mintlify.com](mailto:support@mintlify.com)。请注明你的组织名称以及需要添加的 IP 地址。Mintlify 的支持团队可以添加该地址或禁用允许列表，以便你重新获得访问权限。 +
## 会话有效期
diff --git a/zh/editor/tutorial.mdx b/zh/editor/tutorial.mdx index 3bdb9af5d..1f18cd396 100644 --- a/zh/editor/tutorial.mdx +++ b/zh/editor/tutorial.mdx @@ -6,6 +6,14 @@ keywords: ["编辑器", "教程", "分支", "发布"] 本教程将引导你使用编辑器完成一次完整的内容更新。你将创建一个分支、进行更改、分享预览以供审查，然后发布你的更改。 +
+ ## 前置条件 +
+ +- 一个已连接到 GitHub、GitLab 或 Bitbucket 仓库的 Mintlify 项目。相关设置请参见[连接仓库](/zh/deploy/github)。 +- 一个对项目具有编辑器访问权限的账户。如果你无法登录，请让管理员从[成员](https://app.mintlify.com/settings/organization/members)页面邀请你。 +- 通过你的 Git 提供商在已连接的仓库中打开拉取请求的权限。 + 分支是你内容的临时副本。这是你在不影响线上站点的情况下进行更改的地方。你可以将分支合并到线上站点，或在选择不进行更改时安全地丢弃它。 diff --git a/zh/integrations/privacy/osano.mdx b/zh/integrations/privacy/osano.mdx index c0365fd92..c38234505 100644 --- a/zh/integrations/privacy/osano.mdx +++ b/zh/integrations/privacy/osano.mdx @@ -29,6 +29,14 @@ boost: 3 将 `OSANO_SCRIPT_URL` 替换为你的 Osano 脚本 URL。你的脚本 URL 是 Osano 生成的代码片段中 `src` 的值。你的脚本 URL 始终以 `https://cmp.osano.com/` 开头，并以 `/osano.js` 结尾。 +Mintlify 会自动在你站点的每个页面上包含内容目录中的任何 `.js` 文件。你无需在 `docs.json` 中注册 `osano.js`。详情请参见[自定义 JavaScript](/zh/customize/custom-scripts#custom-javascript)。 + +
+ ## 验证横幅 +
+ +部署后，在隐私或无痕窗口中打开你的站点，确认 Osano 同意横幅是否出现。如果没有出现，请检查浏览器控制台是否有加载 `osano.js` 的错误，并确认脚本 URL 与 Osano 控制台中的一致。 +
## 故障排查
diff --git a/zh/migration-services/go-live-checklist.mdx b/zh/migration-services/go-live-checklist.mdx index 242e888b7..db971eb95 100644 --- a/zh/migration-services/go-live-checklist.mdx +++ b/zh/migration-services/go-live-checklist.mdx @@ -50,6 +50,15 @@ noindex: true - **设置自动化。** 请参阅[如何启用自动化](/zh/automations/manage#enable-an-automation)。 - **安装相关分析插件。** 请参阅[分析集成列表](/zh/integrations/analytics/overview)。 +
+ ## 上线前验证 +
+ +- **在你的 `.mintlify.site` 子域上预览网站。** 每次部署都会获得一个 Mintlify 托管的 URL，例如 `example.mintlify.site`。在将自定义域名指向该网站之前，请以读者的视角浏览一遍。 +- **在本地运行 `mint broken-links`。** 相关设置请参见 [CLI 参考](/zh/cli/commands)。修复它报告的任何失效链接。 +- **验证重定向是否解析到正确的目标。** 针对你的预览 URL 测试每个源路径。 +- **确认身份验证和页面级访问权限。** 如果你设置了身份验证，请以每个访问组中用户的身份登录，验证他们看到的是正确的页面。 +
## 上线