From 02a6766466ca2f308b38e8bd917d05b5ddcb1355 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 1 Sep 2026 10:19:00 +0000 Subject: [PATCH 1/4] docs: fix editor button label, CLI groups flag, BYOK coverage, and draft PR setting --- ai/bring-your-own-model.mdx | 6 ++++-- cli/commands.mdx | 6 +++--- editor/settings.mdx | 8 +++++++- guides/branches.mdx | 16 ++++++++++++++-- 4 files changed, 28 insertions(+), 8 deletions(-) diff --git a/ai/bring-your-own-model.mdx b/ai/bring-your-own-model.mdx index 6fe6537733..aa8dea1de4 100644 --- a/ai/bring-your-own-model.mdx +++ b/ai/bring-your-own-model.mdx @@ -19,8 +19,10 @@ Bring your own model applies to a single deployment, not to your whole organizat | Provider | Coverage | |:---------|:---------| | OpenRouter | Full. Every AI product uses your key and your model. | -| Anthropic | Limited. Some AI products continue to use Mintlify's models. | -| OpenAI-compatible | Limited. Some AI products continue to use Mintlify's models. | +| Anthropic | Limited. The assistant uses your key. The agent and automations continue to use Mintlify's models. | +| OpenAI-compatible | Limited. The assistant uses your key. The agent and automations continue to use Mintlify's models. | + +To run every AI product on your own key, use OpenRouter. Each provider supports a fixed set of models. diff --git a/cli/commands.mdx b/cli/commands.mdx index c2f5d3f165..9531496956 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -30,7 +30,7 @@ mint dev [flags] | --- | --- | | `--port` | Port to run the local preview on. Defaults to `3000`. | | `--no-open` | Do not open the browser automatically. | -| `--groups` | Comma-separated list of user groups to mock for preview. | +| `--groups` | Space-separated list of user groups to mock for preview. For example, `--groups admin user`. | | `--disable-openapi` | Skip OpenAPI file processing to improve performance. | | `--disable-prefetch` | Disable navigation prefetching in the local preview. Useful for very large sites where background prefetching slows down page loads. | | `--local-schema` | Allow locally hosted OpenAPI files served over HTTP. | @@ -542,7 +542,7 @@ mint validate [flags] | Flag | Description | | --- | --- | -| `--groups` | Comma-separated list of user groups to mock for validation. | +| `--groups` | Space-separated list of user groups to mock for validation. For example, `--groups admin user`. | | `--disable-openapi` | Skip OpenAPI file processing and validation. | | `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. | @@ -563,7 +563,7 @@ mint export [flags] | Flag | Description | | --- | --- | | `--output` | Output filename. Defaults to `export.zip`. | -| `--groups` | Comma-separated list of user groups to include restricted pages for. | +| `--groups` | Space-separated list of user groups to include restricted pages for. For example, `--groups admin user`. | | `--disable-openapi` | Skip OpenAPI processing. | See [Offline export](/deploy/export) for details. diff --git a/editor/settings.mdx b/editor/settings.mdx index cf36434fe7..5ef0e57d82 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -8,7 +8,7 @@ keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull reque The editor [settings page](https://app.mintlify.com/settings/deployment/editor) controls the appearance, publishing behavior, and agent behavior. - **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. +- **Publishing**: Deployment-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. Changing them requires permission to update the deployment. If the controls are disabled for you, contact an admin. - **Chat**: Persistent instructions for the editor's AI agent. - **Danger zone**: Actions that can't be undone. @@ -50,6 +50,12 @@ Main branch autocommits push changes to your main branch automatically, shortly 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. +## Create draft pull requests by default + +When this setting is on, pull requests created from the editor open as drafts. Authors mark them ready for review when they finish editing. This setting is on by default. + +Turn it off if you want editor pull requests to open ready for review immediately. + ## PR merge method Choose how the editor merges pull requests when you click **Merge and publish**: diff --git a/guides/branches.mdx b/guides/branches.mdx index c4fb771877..704bfccc40 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -80,7 +80,7 @@ Use clear, descriptive names that explain the purpose of a branch. - Click the **Save as commit** button in the top-right of the editor toolbar. This creates a commit and pushes your work to your branch automatically. + Click the **Save in branch** button in the top-right of the editor toolbar. This creates a commit and pushes your work to your branch automatically. Stage, commit, and push your changes. @@ -126,4 +126,16 @@ Use clear, descriptive names that explain the purpose of a branch. ## Merge branches -Once your changes are ready to publish, create a pull request to merge your branch into the deployment branch. \ No newline at end of file +Once your changes are ready to publish, merge your branch into the deployment branch. + + + + 1. Click **Create pull request** in the top-right of the editor toolbar. The editor opens a pull request that targets your deployment branch. + 1. Review and merge the pull request in your Git provider. + + See [Publishing your changes](/editor/publish) for how the available publish actions change based on your branch and branch protections. + + + Push your branch, then open a pull request in your Git provider that targets your deployment branch. After the pull request merges, Mintlify builds and deploys your changes to your live site. + + From a661c10741410d471bb45e78aa38e5a3bb9512e6 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 1 Sep 2026 10:26:29 +0000 Subject: [PATCH 2/4] docs: mirror PR changes into es, fr, zh and fix overlong translated descriptions --- es/ai/bring-your-own-model.mdx | 8 +++++--- es/cli/commands.mdx | 6 +++--- es/editor/settings.mdx | 8 ++++---- es/guides/branches.mdx | 16 ++++++++++++++-- fr/ai/bring-your-own-model.mdx | 8 +++++--- fr/cli/commands.mdx | 6 +++--- fr/editor/settings.mdx | 8 ++++---- fr/guides/branches.mdx | 16 ++++++++++++++-- zh/ai/bring-your-own-model.mdx | 8 +++++--- zh/cli/commands.mdx | 8 ++++---- zh/editor/settings.mdx | 6 +++--- zh/guides/branches.mdx | 16 ++++++++++++++-- 12 files changed, 78 insertions(+), 36 deletions(-) diff --git a/es/ai/bring-your-own-model.mdx b/es/ai/bring-your-own-model.mdx index f933e7fc8a..51e3cc5280 100644 --- a/es/ai/bring-your-own-model.mdx +++ b/es/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "Usa tu propio modelo" -description: "Usa tu propia clave de API de un proveedor de LLM y elige el modelo que impulsa el assistant, el agente y las automatizaciones de Mintlify en los planes Enterprise." +description: "Usa tu propia clave de API de LLM y elige el modelo que impulsa el assistant, el agente y las automatizaciones de Mintlify en planes Enterprise." keywords: ["BYOK", "clave", "OpenRouter", "Anthropic", "OpenAI", "LLM", "clave de API", "créditos"] --- @@ -21,8 +21,10 @@ Usar tu propio modelo se aplica a un solo deployment, no a toda tu organización | Proveedor | Cobertura | |:---------|:---------| | OpenRouter | Completa. Todos los productos de IA usan tu clave y tu modelo. | -| Anthropic | Limitada. Algunos productos de IA siguen usando los modelos de Mintlify. | -| Compatible con OpenAI | Limitada. Algunos productos de IA siguen usando los modelos de Mintlify. | +| Anthropic | Limitada. El assistant usa tu clave. El agente y las automatizaciones siguen usando los modelos de Mintlify. | +| Compatible con OpenAI | Limitada. El assistant usa tu clave. El agente y las automatizaciones siguen usando los modelos de Mintlify. | + +Para ejecutar todos los productos de IA con tu propia clave, usa OpenRouter. Cada proveedor admite un conjunto fijo de modelos. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index a4595f5a6b..b4ccbd7abb 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -34,7 +34,7 @@ mint dev [flags] | --- | --- | | `--port` | Puerto para ejecutar la previsualización local. Por defecto `3000`. | | `--no-open` | No abrir el navegador automáticamente. | -| `--groups` | Lista separada por comas de grupos de usuarios a simular para la previsualización. | +| `--groups` | Lista separada por espacios de grupos de usuarios a simular para la previsualización. Por ejemplo, `--groups admin user`. | | `--disable-openapi` | Omitir el procesamiento de archivos OpenAPI para mejorar el rendimiento. | | `--disable-prefetch` | Deshabilitar la precarga de navegación en la vista previa local. Útil para sitios muy grandes donde la precarga en segundo plano ralentiza la carga de páginas. | | `--local-schema` | Permitir archivos OpenAPI alojados localmente servidos por HTTP. | @@ -608,7 +608,7 @@ mint validate [flags] | Flag | Descripción | | --- | --- | -| `--groups` | Lista separada por comas de grupos de usuarios a simular para la validación. | +| `--groups` | Lista separada por espacios de grupos de usuarios a simular para la validación. Por ejemplo, `--groups admin user`. | | `--disable-openapi` | Omitir el procesamiento y validación de archivos OpenAPI. | | `--local-schema` | Permitir la validación de archivos OpenAPI alojados localmente servidos por HTTP. Solo admite HTTPS en producción. | @@ -631,7 +631,7 @@ mint export [flags] | Flag | Descripción | | --- | --- | | `--output` | Nombre del archivo de salida. Por defecto `export.zip`. | -| `--groups` | Lista separada por comas de grupos de usuarios para incluir páginas restringidas. | +| `--groups` | Lista separada por espacios de grupos de usuarios para incluir páginas restringidas. Por ejemplo, `--groups admin user`. | | `--disable-openapi` | Omitir el procesamiento de OpenAPI. | Consulta [Exportación offline](/es/deploy/export) para más detalles. diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index 4f47fcceae..2892010e4e 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -1,14 +1,14 @@ --- title: "Configuración del editor para IA y publicación" sidebarTitle: "Configuración" -description: "Configure la apariencia del editor, las instrucciones de IA y los valores predeterminados de publicación para controlar cómo se ve el editor y cómo confirma y hace merge de los cambios." +description: "Configure la apariencia del editor, las instrucciones de IA y los valores de publicación que controlan cómo el editor confirma y hace merge de los cambios." keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- La [página de configuración](https://app.mintlify.com/settings/deployment/editor) del editor controla la apariencia, el comportamiento de publicación y el comportamiento del agente. - **Appearance**: Preferencias personales sobre cómo se ve y se comporta el editor. Se aplican solo a usted. -- **Publishing**: Valores predeterminados de todo el deployment sobre cómo el editor confirma cambios y abre pull requests. Se aplican a todas las personas que publican. +- **Publishing**: Valores predeterminados de todo el deployment sobre cómo el editor confirma cambios y abre pull requests. Se aplican a todas las personas que publican. Cambiarlos requiere permiso para actualizar el deployment. Si los controles están deshabilitados para usted, contacte a un administrador. - **Chat**: Instrucciones persistentes para el agente de IA del editor. - **Danger zone**: Acciones que no se pueden deshacer. @@ -68,9 +68,9 @@ Los autocommits en la branch main envían los cambios a su branch main automáti -Cuando este ajuste está activado, las pull requests nuevas creadas desde el editor se abren como borradores. No puede hacer merge de una pull request en borrador hasta que la marque como lista para revisión. Está activado de forma predeterminada. +Cuando este ajuste está activado, las pull requests creadas desde el editor se abren como borradores. Los autores las marcan como listas para revisión cuando terminan de editar. Este ajuste está activado de forma predeterminada. -Las pull requests en borrador son útiles cuando su equipo requiere una revisión manual antes de abrir una pull request para su aprobación, o cuando quiere compartir URLs de vista previa sin dar a entender que el cambio está listo para hacer merge. +Desactívelo si quiere que las pull requests del editor se abran listas para revisión de inmediato.
diff --git a/es/guides/branches.mdx b/es/guides/branches.mdx index a5caf7c79c..79f4df8806 100644 --- a/es/guides/branches.mdx +++ b/es/guides/branches.mdx @@ -87,7 +87,7 @@ Usa nombres claros y descriptivos que indiquen el propósito de un branch. - Selecciona el botón **Save as commit** en la parte superior derecha de la barra de herramientas del editor. Esto crea una confirmación y sube tu trabajo a tu branch automáticamente. + Selecciona el botón **Save in branch** en la parte superior derecha de la barra de herramientas del editor. Esto crea una confirmación y sube tu trabajo a tu branch automáticamente. @@ -136,4 +136,16 @@ Usa nombres claros y descriptivos que indiquen el propósito de un branch. ## Fusionar branches
-Cuando tus cambios estén listos para su publicación, crea una solicitud de extracción para fusionar tu branch en la rama de implementación. \ No newline at end of file +Cuando tus cambios estén listos para su publicación, fusiona tu branch en la rama de implementación. + + + + 1. Haz clic en **Create pull request** en la parte superior derecha de la barra de herramientas del editor. El editor abre una solicitud de extracción dirigida a tu rama de implementación. + 1. Revisa y fusiona la solicitud de extracción en tu proveedor de Git. + + Consulta [Publicar cambios](/es/editor/publish) para saber cómo cambian las acciones de publicación disponibles según tu branch y las protecciones de branch. + + + Sube tu branch y luego abre una solicitud de extracción en tu proveedor de Git dirigida a tu rama de implementación. Después de que la solicitud de extracción se fusione, Mintlify compila y despliega tus cambios en tu sitio en producción. + + diff --git a/fr/ai/bring-your-own-model.mdx b/fr/ai/bring-your-own-model.mdx index a6f40eb966..f0c05b9536 100644 --- a/fr/ai/bring-your-own-model.mdx +++ b/fr/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "Utiliser votre propre modèle" -description: "Utilisez votre propre clé d'API de fournisseur LLM et choisissez le modèle qui alimente l'assistant, l'agent et les automatisations Mintlify sur les forfaits Enterprise." +description: "Utilisez votre propre clé d'API LLM et choisissez le modèle qui alimente l'assistant, l'agent et les automatisations Mintlify sur les forfaits Enterprise." keywords: ["BYOK", "clé", "OpenRouter", "Anthropic", "OpenAI", "LLM", "clé d'API", "crédits"] --- @@ -21,8 +21,10 @@ L'utilisation de votre propre modèle s'applique à un seul déploiement, pas à | Fournisseur | Couverture | |:---------|:---------| | OpenRouter | Complète. Tous les produits d'IA utilisent votre clé et votre modèle. | -| Anthropic | Limitée. Certains produits d'IA continuent d'utiliser les modèles de Mintlify. | -| Compatible OpenAI | Limitée. Certains produits d'IA continuent d'utiliser les modèles de Mintlify. | +| Anthropic | Limitée. L'assistant utilise votre clé. L'agent et les automatisations continuent d'utiliser les modèles de Mintlify. | +| Compatible OpenAI | Limitée. L'assistant utilise votre clé. L'agent et les automatisations continuent d'utiliser les modèles de Mintlify. | + +Pour exécuter tous les produits d'IA avec votre propre clé, utilisez OpenRouter. Chaque fournisseur prend en charge un ensemble fixe de modèles. diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index ce7d9d26fc..92eccab19f 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -34,7 +34,7 @@ mint dev [flags] | --- | --- | | `--port` | Port pour la prévisualisation locale. Par défaut `3000`. | | `--no-open` | Ne pas ouvrir le navigateur automatiquement. | -| `--groups` | Liste séparée par des virgules de groupes d'utilisateurs à simuler pour la prévisualisation. | +| `--groups` | Liste séparée par des espaces de groupes d'utilisateurs à simuler pour la prévisualisation. Par exemple, `--groups admin user`. | | `--disable-openapi` | Ignorer le traitement des fichiers OpenAPI pour améliorer les performances. | | `--disable-prefetch` | Désactiver le préchargement de la navigation dans la prévisualisation locale. Utile pour les très grands sites où le préchargement en arrière-plan ralentit le chargement des pages. | | `--local-schema` | Autoriser les fichiers OpenAPI hébergés localement servis via HTTP. | @@ -610,7 +610,7 @@ mint validate [flags] | Flag | Description | | --- | --- | -| `--groups` | Liste séparée par des virgules de groupes d'utilisateurs à simuler pour la validation. | +| `--groups` | Liste séparée par des espaces de groupes d'utilisateurs à simuler pour la validation. Par exemple, `--groups admin user`. | | `--disable-openapi` | Ignorer le traitement et la validation des fichiers OpenAPI. | | `--local-schema` | Autoriser la validation des fichiers OpenAPI hébergés localement servis via HTTP. Ne prend en charge que HTTPS en production. | @@ -633,7 +633,7 @@ mint export [flags] | Flag | Description | | --- | --- | | `--output` | Nom du fichier de sortie. Par défaut `export.zip`. | -| `--groups` | Liste séparée par des virgules de groupes d'utilisateurs pour inclure les pages restreintes. | +| `--groups` | Liste séparée par des espaces de groupes d'utilisateurs pour inclure les pages restreintes. Par exemple, `--groups admin user`. | | `--disable-openapi` | Ignorer le traitement OpenAPI. | Consultez [Export hors ligne](/fr/deploy/export) pour plus de détails. diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index 7712ae1443..a283f4d0ca 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -1,14 +1,14 @@ --- title: "Paramètres de l'éditeur pour l'IA et la publication" sidebarTitle: "Paramètres" -description: "Configurez l'apparence de l'éditeur, les instructions d'IA et les valeurs par défaut de publication pour contrôler l'aspect de l'éditeur et la façon dont il commit et fusionne les modifications." +description: "Configurez l'apparence de l'éditeur, les instructions d'IA et les valeurs de publication contrôlant comment l'éditeur commit et fusionne les modifications." keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- La [page de paramètres](https://app.mintlify.com/settings/deployment/editor) de l'éditeur contrôle l'apparence, le comportement de publication et le comportement de l'agent. - **Appearance** : Préférences personnelles sur l'aspect et le comportement de l'éditeur. Elles ne s'appliquent qu'à vous. -- **Publishing** : Valeurs par défaut, à l'échelle du deployment, sur la façon dont l'éditeur commit les modifications et ouvre les pull requests. Elles s'appliquent à toutes les personnes qui publient. +- **Publishing** : Valeurs par défaut, à l'échelle du deployment, sur la façon dont l'éditeur commit les modifications et ouvre les pull requests. Elles s'appliquent à toutes les personnes qui publient. Leur modification nécessite l'autorisation de mettre à jour le deployment. Si les contrôles sont désactivés pour vous, contactez un admin. - **Chat** : Instructions persistantes pour l'agent d'IA de l'éditeur. - **Danger zone** : Actions irréversibles. @@ -68,9 +68,9 @@ Les autocommits sur la branch main poussent vos modifications vers votre branch -Lorsque ce paramètre est activé, les nouvelles pull requests créées depuis l'éditeur s'ouvrent en brouillon. Vous ne pouvez pas fusionner une pull request en brouillon tant que vous ne l'avez pas marquée comme prête à être relue. Ce paramètre est activé par défaut. +Lorsque ce paramètre est activé, les pull requests créées depuis l'éditeur s'ouvrent en brouillon. Les auteurs les marquent comme prêtes à être relues lorsqu'ils ont terminé leurs modifications. Ce paramètre est activé par défaut. -Les pull requests en brouillon sont utiles lorsque votre équipe exige une relecture manuelle avant d'ouvrir une pull request à l'approbation, ou lorsque vous voulez partager des URLs de prévisualisation sans laisser entendre que la modification est prête à être fusionnée. +Désactivez-le si vous voulez que les pull requests de l'éditeur s'ouvrent immédiatement prêtes à être relues.
diff --git a/fr/guides/branches.mdx b/fr/guides/branches.mdx index e9f9cf2625..aa5d1df9b4 100644 --- a/fr/guides/branches.mdx +++ b/fr/guides/branches.mdx @@ -87,7 +87,7 @@ Utilisez des noms explicites et descriptifs qui indiquent clairement l’objecti - Cliquez sur le bouton **Save as commit** dans le coin supérieur droit de la barre d'outils de l'éditeur. Cela crée un commit et envoie automatiquement votre travail sur votre branche. + Cliquez sur le bouton **Save in branch** dans le coin supérieur droit de la barre d'outils de l'éditeur. Cela crée un commit et envoie automatiquement votre travail sur votre branche. Préparez, validez, puis poussez vos modifications. @@ -135,4 +135,16 @@ Utilisez des noms explicites et descriptifs qui indiquent clairement l’objecti ## Fusionner des branches
-Une fois que vos modifications sont prêtes à être publiées, créez une pull request (demande de fusion) pour fusionner votre branche dans la branche de déploiement. \ No newline at end of file +Une fois que vos modifications sont prêtes à être publiées, fusionnez votre branche dans la branche de déploiement. + + + + 1. Cliquez sur **Create pull request** dans le coin supérieur droit de la barre d’outils de l’éditeur. L’éditeur ouvre une pull request qui cible votre branche de déploiement. + 1. Relisez et fusionnez la pull request dans votre fournisseur Git. + + Consultez [Publier vos modifications](/fr/editor/publish) pour savoir comment les actions de publication disponibles changent en fonction de votre branche et des protections de branche. + + + Poussez votre branche, puis ouvrez une pull request dans votre fournisseur Git qui cible votre branche de déploiement. Une fois la pull request fusionnée, Mintlify génère et déploie vos modifications sur votre site en ligne. + + diff --git a/zh/ai/bring-your-own-model.mdx b/zh/ai/bring-your-own-model.mdx index 7664bb0de9..51580d813e 100644 --- a/zh/ai/bring-your-own-model.mdx +++ b/zh/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "使用自己的模型" -description: "在 Enterprise 方案中，使用你自己的 LLM 提供商 API 密钥，并选择为 Mintlify assistant、agent 和自动化提供支持的模型。" +description: "使用你自己的 LLM 提供商 API 密钥，选择为 Mintlify assistant、agent 和自动化提供支持的模型。" keywords: ["BYOK", "密钥", "OpenRouter", "Anthropic", "OpenAI", "LLM", "API 密钥", "积分"] --- @@ -21,8 +21,10 @@ keywords: ["BYOK", "密钥", "OpenRouter", "Anthropic", "OpenAI", "LLM", "API | 提供商 | 覆盖范围 | |:---------|:---------| | OpenRouter | 完整。所有 AI 产品都使用你的密钥和你的模型。 | -| Anthropic | 有限。部分 AI 产品会继续使用 Mintlify 的模型。 | -| 兼容 OpenAI | 有限。部分 AI 产品会继续使用 Mintlify 的模型。 | +| Anthropic | 有限。assistant 使用你的密钥。agent 和自动化会继续使用 Mintlify 的模型。 | +| 兼容 OpenAI | 有限。assistant 使用你的密钥。agent 和自动化会继续使用 Mintlify 的模型。 | + +要让所有 AI 产品都通过你自己的密钥运行，请使用 OpenRouter。 每个提供商都支持一组固定的模型。 diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index afdd983fb7..d233cf9cde 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify CLI 命令参考" sidebarTitle: "命令参考" -description: "Mintlify CLI 所有命令和选项的完整参考，涵盖 mint index、mint dev、mint validate 和 mint broken-links，并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流，帮助你完成日常文档开发以及部署前检查。" +description: "Mintlify CLI 命令与选项的完整参考，涵盖 mint dev、mint validate、mint broken-links 等命令及部署前检查。" keywords: ["CLI", "mint", "命令", "选项", "参考"] boost: 3 --- @@ -34,7 +34,7 @@ mint dev [flags] | --- | --- | | `--port` | 本地预览使用的端口。默认为 `3000`。 | | `--no-open` | 不自动打开浏览器。 | -| `--groups` | 以逗号分隔的用户组列表，用于模拟预览。 | +| `--groups` | 以空格分隔的用户组列表，用于模拟预览。例如 `--groups admin user`。 | | `--disable-openapi` | 跳过 OpenAPI 文件处理以提高性能。 | | `--disable-prefetch` | 在本地预览中禁用导航预加载。适用于后台预加载会拖慢页面加载的超大型站点。 | | `--local-schema` | 允许通过 HTTP 提供的本地托管 OpenAPI 文件。 | @@ -610,7 +610,7 @@ mint validate [flags] | 选项 | 描述 | | --- | --- | -| `--groups` | 以逗号分隔的用户组列表，用于模拟验证。 | +| `--groups` | 以空格分隔的用户组列表，用于模拟验证。例如 `--groups admin user`。 | | `--disable-openapi` | 跳过 OpenAPI 文件处理和验证。 | | `--local-schema` | 允许验证通过 HTTP 提供的本地托管 OpenAPI 文件。生产环境仅支持 HTTPS。 | @@ -633,7 +633,7 @@ mint export [flags] | 选项 | 描述 | | --- | --- | | `--output` | 输出文件名。默认为 `export.zip`。 | -| `--groups` | 以逗号分隔的用户组列表，用于包含受限页面。 | +| `--groups` | 以空格分隔的用户组列表，用于包含受限页面。例如 `--groups admin user`。 | | `--disable-openapi` | 跳过 OpenAPI 处理。 | 有关详细信息，请参阅[离线导出](/zh/deploy/export)。 diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 0f3b12ce87..383d9b56a5 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -8,7 +8,7 @@ keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull reque 编辑器的[设置页面](https://app.mintlify.com/settings/deployment/editor)控制外观、发布行为和智能体行为。 - **Appearance**：关于编辑器外观和行为的个人偏好，仅对你生效。 -- **Publishing**：整个 deployment 范围内的默认设置，决定编辑器如何提交更改和打开 pull request，对所有发布者生效。 +- **Publishing**：整个 deployment 范围内的默认设置，决定编辑器如何提交更改和打开 pull request，对所有发布者生效。更改这些设置需要具备更新 deployment 的权限。如果这些控件对你处于禁用状态，请联系管理员。 - **Chat**：编辑器 AI 智能体的持久说明。 - **Danger zone**：无法撤销的操作。 @@ -68,9 +68,9 @@ main 分支自动提交会在你停止输入后不久，自动把更改推送到 -启用该设置后，从编辑器创建的新 pull request 会以草稿形式打开。在你将其标记为可供审阅之前，无法合并草稿 pull request。该设置默认启用。 +启用该设置后，从编辑器创建的 pull request 会以草稿形式打开。作者在完成编辑后将其标记为可供审阅。该设置默认启用。 -当团队要求在开放审批之前先进行一次人工检查，或者你希望共享预览 URL 但不暗示该更改已可合并时，草稿 pull request 会很有用。 +如果你希望从编辑器创建的 pull request 一打开就处于可供审阅状态，请关闭该设置。
diff --git a/zh/guides/branches.mdx b/zh/guides/branches.mdx index 289d8e0644..72cadeebfa 100644 --- a/zh/guides/branches.mdx +++ b/zh/guides/branches.mdx @@ -87,7 +87,7 @@ gitGraph - 在编辑器工具栏右上角选择 **Save as commit** 按钮。这会创建一个提交，并自动将你的更改推送到你的 branch。 + 在编辑器工具栏右上角选择 **Save in branch** 按钮。这会创建一个提交，并自动将你的更改推送到你的 branch。 @@ -138,4 +138,16 @@ gitGraph ## 合并 branch
-当你的更改准备好发布时，创建一个拉取请求（PR；亦称“合并请求”/Merge Request），将你的 branch 合并到部署用分支。 \ No newline at end of file +当你的更改准备好发布时，将你的 branch 合并到部署用分支。 + + + + 1. 点击编辑器工具栏右上角的 **Create pull request**。编辑器会打开一个以你的部署用分支为目标的拉取请求。 + 1. 在你的 Git 提供商中评审并合并该拉取请求。 + + 关于可用的发布操作如何随你的 branch 和分支保护规则而变化，请参阅[发布更改](/zh/editor/publish)。 + + + 推送你的 branch，然后在你的 Git 提供商中打开一个以你的部署用分支为目标的拉取请求。拉取请求合并后，Mintlify 会构建你的更改并将其部署到在线站点。 + + From c159686977b9f9e86dca4c522fd64f8d1cc98f70 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:48:35 -0700 Subject: [PATCH 3/4] docs: clarify branch publishing and draft PR review steps --- es/guides/branches.mdx | 6 +++++- fr/guides/branches.mdx | 6 +++++- guides/branches.mdx | 6 +++++- zh/guides/branches.mdx | 6 +++++- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/es/guides/branches.mdx b/es/guides/branches.mdx index 79f4df8806..e6807dc4a8 100644 --- a/es/guides/branches.mdx +++ b/es/guides/branches.mdx @@ -140,8 +140,12 @@ Cuando tus cambios estén listos para su publicación, fusiona tu branch en la r + Si Mintlify aloja tu repositorio, haz clic en **Merge and publish** para fusionar tu branch y publicar tus cambios. + + Si conectaste tu propio repositorio de Git: + 1. Haz clic en **Create pull request** en la parte superior derecha de la barra de herramientas del editor. El editor abre una solicitud de extracción dirigida a tu rama de implementación. - 1. Revisa y fusiona la solicitud de extracción en tu proveedor de Git. + 1. En tu proveedor de Git, marca la solicitud de extracción como lista para revisión si es un borrador. Completa las revisiones y comprobaciones requeridas y, a continuación, fusiónala. Consulta [Publicar cambios](/es/editor/publish) para saber cómo cambian las acciones de publicación disponibles según tu branch y las protecciones de branch. diff --git a/fr/guides/branches.mdx b/fr/guides/branches.mdx index aa5d1df9b4..ed6b0010e0 100644 --- a/fr/guides/branches.mdx +++ b/fr/guides/branches.mdx @@ -139,8 +139,12 @@ Une fois que vos modifications sont prêtes à être publiées, fusionnez votre + Si Mintlify héberge votre dépôt, cliquez sur **Merge and publish** pour fusionner votre branche et publier vos modifications. + + Si vous avez connecté votre propre dépôt Git : + 1. Cliquez sur **Create pull request** dans le coin supérieur droit de la barre d’outils de l’éditeur. L’éditeur ouvre une pull request qui cible votre branche de déploiement. - 1. Relisez et fusionnez la pull request dans votre fournisseur Git. + 1. Dans votre fournisseur Git, marquez la pull request comme prête à être relue si elle est en brouillon. Effectuez les relectures et vérifications requises, puis fusionnez-la. Consultez [Publier vos modifications](/fr/editor/publish) pour savoir comment les actions de publication disponibles changent en fonction de votre branche et des protections de branche. diff --git a/guides/branches.mdx b/guides/branches.mdx index 704bfccc40..9f28acd477 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -130,8 +130,12 @@ Once your changes are ready to publish, merge your branch into the deployment br + If Mintlify hosts your repository, click **Merge and publish** to merge your branch and publish your changes. + + If you connected your own Git repository: + 1. Click **Create pull request** in the top-right of the editor toolbar. The editor opens a pull request that targets your deployment branch. - 1. Review and merge the pull request in your Git provider. + 1. In your Git provider, mark the pull request ready for review if it is a draft. Complete any required reviews and checks, then merge it. See [Publishing your changes](/editor/publish) for how the available publish actions change based on your branch and branch protections. diff --git a/zh/guides/branches.mdx b/zh/guides/branches.mdx index 72cadeebfa..81cd712147 100644 --- a/zh/guides/branches.mdx +++ b/zh/guides/branches.mdx @@ -142,8 +142,12 @@ gitGraph + 如果你的仓库由 Mintlify 托管，请点击 **Merge and publish** 来合并你的 branch 并发布更改。 + + 如果你连接了自己的 Git 仓库： + 1. 点击编辑器工具栏右上角的 **Create pull request**。编辑器会打开一个以你的部署用分支为目标的拉取请求。 - 1. 在你的 Git 提供商中评审并合并该拉取请求。 + 1. 在你的 Git 提供商中，如果该拉取请求处于草稿状态，请将其标记为可供审阅。完成所有必需的评审和检查后，合并该拉取请求。 关于可用的发布操作如何随你的 branch 和分支保护规则而变化，请参阅[发布更改](/zh/editor/publish)。 From 19494a478d92225b03d7c3fc8be9917694bca555 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:53:37 -0700 Subject: [PATCH 4/4] Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- ai/bring-your-own-model.mdx | 2 -- editor/settings.mdx | 4 ++-- guides/branches.mdx | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/ai/bring-your-own-model.mdx b/ai/bring-your-own-model.mdx index aa8dea1de4..47b482b222 100644 --- a/ai/bring-your-own-model.mdx +++ b/ai/bring-your-own-model.mdx @@ -22,8 +22,6 @@ Bring your own model applies to a single deployment, not to your whole organizat | Anthropic | Limited. The assistant uses your key. The agent and automations continue to use Mintlify's models. | | OpenAI-compatible | Limited. The assistant uses your key. The agent and automations continue to use Mintlify's models. | -To run every AI product on your own key, use OpenRouter. - Each provider supports a fixed set of models. ## Configure your model diff --git a/editor/settings.mdx b/editor/settings.mdx index b46492a5b7..8c9099b209 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -8,7 +8,7 @@ keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull reque The editor [settings page](https://app.mintlify.com/settings/deployment/editor) controls the appearance, publishing behavior, and agent behavior. - **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. Changing them requires permission to update the deployment. If the controls are disabled for you, contact an admin. +- **Publishing**: Deployment-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. Only admins can update publishing behavior. - **Chat**: Persistent instructions for the editor's AI agent. - **Danger zone**: Actions that can't be undone. @@ -54,7 +54,7 @@ Main branch autocommits push changes to your main branch automatically, shortly When this setting is on, pull requests created from the editor open as drafts. Authors mark them ready for review when they finish editing. This setting is on by default. -Turn it off if you want editor pull requests to open ready for review immediately. +If you want editor pull requests to open ready for review immediately, turn off draft pull requests. ## PR merge method diff --git a/guides/branches.mdx b/guides/branches.mdx index 2591892560..b29623b42a 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -129,7 +129,7 @@ Use clear, descriptive names that explain the purpose of a branch. Once your changes are ready to publish, merge your branch into the deployment branch. - + If Mintlify hosts your repository, click **Merge and publish** to merge your branch and publish your changes. If you connected your own Git repository: