From 58b5d34dac905c6b16b821cf75554e20c717aff2 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 05:10:08 +0000 Subject: [PATCH 1/5] docs: document deployment branch lock in editor settings --- editor/settings.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/editor/settings.mdx b/editor/settings.mdx index 025be12ff..7daa95687 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "Editor settings for AI and publishing" description: "Configure AI instructions, pull request defaults, draft behavior, and the default merge method to control how the Mintlify web editor publishes changes." -keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge"] +keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge", "lock branch"] --- The web editor has two layers of settings: @@ -57,6 +57,21 @@ You configure publishing settings per deployment, and they apply to everyone who You need admin access to your Mintlify deployment to change publishing settings. +### Lock the deployment branch + +Turn this on to make your deployment branch (usually `main`) read-only in the editor. When the branch is locked: + +- The editor and source view become read-only for anyone viewing the deployment branch. +- The `docs.json` configuration panel stops saving changes. +- Navigation edits — adding pages, reordering, and drag-and-drop — are hidden. +- A banner prompts contributors to create a draft branch before making edits. + +Your deployment branch stays in sync with Git, so pushes from your repository still update your live site. Locking only affects edits made from the editor. + +Use this setting when your team wants Git to remain the source of truth for the live site, and all editor changes to flow through pull requests from draft branches. + +To edit while the deployment branch is locked, use the branch picker in the top bar to create or switch to a draft branch. You publish those changes by opening a pull request from your draft branch, the same as any other editor branch. + ### Pull request instructions Pull request instructions guide the AI when it generates a pull request title and description. They apply whenever the editor opens a pull request on your behalf, including from **Create pull request** and **Merge and publish** flows. From 02663eb45573772d5e367732dab26916cc235f52 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 05:12:06 +0000 Subject: [PATCH 2/5] docs: mirror deployment branch lock translations (fr, es, zh) --- es/editor/settings.mdx | 21 ++++++++++++++++++++- fr/editor/settings.mdx | 21 ++++++++++++++++++++- zh/editor/settings.mdx | 19 ++++++++++++++++++- 3 files changed, 58 insertions(+), 3 deletions(-) diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index b1be43958..91f09a035 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "Configuración del editor para IA y publicación" description: "Configure instrucciones de IA, valores predeterminados de pull requests, comportamiento de borradores y método de fusión en el editor web de Mintlify." -keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge"] +keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge", "lock branch"] --- El editor web tiene dos capas de configuración: @@ -73,6 +73,25 @@ La configuración de publicación se establece por deployment y se aplica a toda Necesita acceso de administrador a su deployment de Mintlify para cambiar la configuración de publicación. +
+ +### Bloquear la rama de despliegue + +
+ +Actívalo para que tu rama de despliegue (normalmente `main`) sea de solo lectura en el editor. Cuando la rama está bloqueada: + +- El editor y la vista de código fuente pasan a solo lectura para cualquier persona que esté viendo la rama de despliegue. +- El panel de configuración de `docs.json` deja de guardar cambios. +- Las ediciones de navegación —agregar páginas, reordenar y arrastrar y soltar— se ocultan. +- Un aviso pide a los colaboradores que creen una rama borrador antes de hacer ediciones. + +Tu rama de despliegue permanece sincronizada con Git, por lo que los push desde tu repositorio siguen actualizando tu sitio en producción. El bloqueo solo afecta a las ediciones realizadas desde el editor. + +Usa este ajuste cuando tu equipo quiera que Git siga siendo la fuente de verdad del sitio en producción, y que todos los cambios del editor pasen por pull requests desde ramas borrador. + +Para editar mientras la rama de despliegue está bloqueada, usa el selector de ramas en la barra superior para crear una rama borrador o cambiarte a una. Publica esos cambios abriendo un pull request desde tu rama borrador, igual que con cualquier otra rama del editor. +
### Instrucciones para el pull request diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index 74c2512a6..5c89fe717 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "Paramètres de l'éditeur pour l'IA et la publication" description: "Configurez les instructions IA, les valeurs par défaut des pull requests, les brouillons et la méthode de fusion utilisée par l'éditeur web." -keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge"] +keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "draft", "merge", "lock branch"] --- L'éditeur web comporte deux niveaux de paramètres : @@ -73,6 +73,25 @@ Vous configurez les paramètres de publication par déploiement, et ils s'appliq Vous devez disposer d'un accès administrateur à votre déploiement Mintlify pour modifier les paramètres de publication. +
+ +### Verrouiller la branche de déploiement + +
+ +Activez cette option pour rendre votre branche de déploiement (généralement `main`) en lecture seule dans l'éditeur. Lorsque la branche est verrouillée : + +- L'éditeur et la vue source deviennent en lecture seule pour toute personne consultant la branche de déploiement. +- Le panneau de configuration `docs.json` cesse d'enregistrer les modifications. +- Les modifications de navigation — ajout de pages, réorganisation et glisser-déposer — sont masquées. +- Une bannière invite les contributeurs à créer une branche de brouillon avant de faire des modifications. + +Votre branche de déploiement reste synchronisée avec Git, donc les push depuis votre dépôt continuent de mettre à jour votre site en direct. Le verrouillage n'affecte que les modifications effectuées depuis l'éditeur. + +Utilisez ce paramètre lorsque votre équipe souhaite que Git reste la source de vérité pour le site en direct, et que toutes les modifications faites dans l'éditeur passent par des pull requests depuis des branches de brouillon. + +Pour modifier pendant que la branche de déploiement est verrouillée, utilisez le sélecteur de branche dans la barre supérieure pour créer une branche de brouillon ou basculer vers celle-ci. Publiez ces modifications en ouvrant une pull request depuis votre branche de brouillon, comme pour toute autre branche de l'éditeur. +
### Instructions pour la pull request diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 68211bda6..95c5c653f 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "用于 AI 与发布的编辑器设置" description: "配置 AI 指令、pull request 默认值、草稿行为以及默认合并方式，以控制 Mintlify Web 编辑器发布变更的方式。" -keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "草稿", "合并"] +keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "草稿", "合并", "锁定分支"] --- Web 编辑器有两层设置： @@ -66,6 +66,23 @@ AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。 你需要拥有 Mintlify 部署的管理员权限才能更改发布设置。 +
+ ### 锁定部署分支 +
+ +启用此选项可将你的部署分支（通常是 `main`）在编辑器中设为只读。分支被锁定后： + +- 对于查看部署分支的所有人，编辑器和源代码视图都变为只读。 +- `docs.json` 配置面板停止保存更改。 +- 导航编辑（添加页面、重新排序和拖放）会被隐藏。 +- 横幅会提示贡献者先创建草稿分支再进行编辑。 + +你的部署分支仍与 Git 保持同步，因此从仓库推送仍会更新线上站点。锁定只影响在编辑器中所做的更改。 + +当你的团队希望 Git 继续作为线上站点的唯一可信来源，并让所有编辑器更改都通过从草稿分支发起的 pull request 提交时，可使用此设置。 + +在部署分支被锁定时进行编辑，请使用顶栏中的分支选择器创建或切换到草稿分支。像其他编辑器分支一样，从你的草稿分支发起 pull request 即可发布这些更改。 +
### Pull request 指令
From e3cb79262fa1dfd0142ff2d98ab9ee6d88063823 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 05:16:55 +0000 Subject: [PATCH 3/5] docs: warn that locking discards unpublished editor changes --- editor/settings.mdx | 6 ++++++ es/editor/settings.mdx | 6 ++++++ fr/editor/settings.mdx | 6 ++++++ zh/editor/settings.mdx | 6 ++++++ 4 files changed, 24 insertions(+) diff --git a/editor/settings.mdx b/editor/settings.mdx index 7daa95687..4341e3f45 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -68,6 +68,12 @@ Turn this on to make your deployment branch (usually `main`) read-only in the ed Your deployment branch stays in sync with Git, so pushes from your repository still update your live site. Locking only affects edits made from the editor. + + Turning on the lock discards any unpublished editor changes on the deployment branch and force-syncs the editor with your Git repository. Publish or move pending edits to a draft branch before you enable the lock. + + +While the lock is on, incoming Git pushes to the deployment branch overwrite the editor's live state, so any in-flight edits on that branch are replaced by the latest commit. + Use this setting when your team wants Git to remain the source of truth for the live site, and all editor changes to flow through pull requests from draft branches. To edit while the deployment branch is locked, use the branch picker in the top bar to create or switch to a draft branch. You publish those changes by opening a pull request from your draft branch, the same as any other editor branch. diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index 91f09a035..cdc38600f 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -88,6 +88,12 @@ Actívalo para que tu rama de despliegue (normalmente `main`) sea de solo lectur Tu rama de despliegue permanece sincronizada con Git, por lo que los push desde tu repositorio siguen actualizando tu sitio en producción. El bloqueo solo afecta a las ediciones realizadas desde el editor. + + Activar el bloqueo descarta cualquier edición del editor sin publicar en la rama de despliegue y fuerza la sincronización del editor con tu repositorio de Git. Publica las ediciones pendientes o muévelas a una rama borrador antes de activar el bloqueo. + + +Mientras el bloqueo esté activo, los push entrantes de Git a la rama de despliegue sobrescriben el estado en vivo del editor, por lo que cualquier edición en curso en esa rama se reemplaza con el último commit. + Usa este ajuste cuando tu equipo quiera que Git siga siendo la fuente de verdad del sitio en producción, y que todos los cambios del editor pasen por pull requests desde ramas borrador. Para editar mientras la rama de despliegue está bloqueada, usa el selector de ramas en la barra superior para crear una rama borrador o cambiarte a una. Publica esos cambios abriendo un pull request desde tu rama borrador, igual que con cualquier otra rama del editor. diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index 5c89fe717..9987956c8 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -88,6 +88,12 @@ Activez cette option pour rendre votre branche de déploiement (généralement ` Votre branche de déploiement reste synchronisée avec Git, donc les push depuis votre dépôt continuent de mettre à jour votre site en direct. Le verrouillage n'affecte que les modifications effectuées depuis l'éditeur. + + Activer le verrouillage abandonne toutes les modifications non publiées de l'éditeur sur la branche de déploiement et force la resynchronisation de l'éditeur avec votre dépôt Git. Publiez les modifications en attente ou déplacez-les vers une branche de brouillon avant d'activer le verrouillage. + + +Tant que le verrouillage est actif, les push Git entrants vers la branche de déploiement écrasent l'état en direct de l'éditeur, de sorte que toute modification en cours sur cette branche est remplacée par le dernier commit. + Utilisez ce paramètre lorsque votre équipe souhaite que Git reste la source de vérité pour le site en direct, et que toutes les modifications faites dans l'éditeur passent par des pull requests depuis des branches de brouillon. Pour modifier pendant que la branche de déploiement est verrouillée, utilisez le sélecteur de branche dans la barre supérieure pour créer une branche de brouillon ou basculer vers celle-ci. Publiez ces modifications en ouvrant une pull request depuis votre branche de brouillon, comme pour toute autre branche de l'éditeur. diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 95c5c653f..18680adf7 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -79,6 +79,12 @@ AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。 你的部署分支仍与 Git 保持同步，因此从仓库推送仍会更新线上站点。锁定只影响在编辑器中所做的更改。 + + 开启锁定会丢弃部署分支上所有未发布的编辑器更改，并强制将编辑器与你的 Git 仓库重新同步。在开启锁定之前，请先发布待处理的编辑，或将其移动到草稿分支。 + + +在锁定开启期间，向部署分支推送的 Git 提交会覆盖编辑器的实时状态，因此该分支上任何进行中的编辑都会被最新的提交替换。 + 当你的团队希望 Git 继续作为线上站点的唯一可信来源，并让所有编辑器更改都通过从草稿分支发起的 pull request 提交时，可使用此设置。 在部署分支被锁定时进行编辑，请使用顶栏中的分支选择器创建或切换到草稿分支。像其他编辑器分支一样，从你的草稿分支发起 pull request 即可发布这些更改。 From f488e81ed356eccbc51116268b6537ff6a6af0f8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 13 Jul 2026 16:42:53 -0700 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Denzell <32852291+cdxker@users.noreply.github.com> --- editor/settings.mdx | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/editor/settings.mdx b/editor/settings.mdx index 4341e3f45..0131ae31a 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -61,22 +61,11 @@ You need admin access to your Mintlify deployment to change publishing settings. Turn this on to make your deployment branch (usually `main`) read-only in the editor. When the branch is locked: -- The editor and source view become read-only for anyone viewing the deployment branch. -- The `docs.json` configuration panel stops saving changes. -- Navigation edits — adding pages, reordering, and drag-and-drop — are hidden. -- A banner prompts contributors to create a draft branch before making edits. -Your deployment branch stays in sync with Git, so pushes from your repository still update your live site. Locking only affects edits made from the editor. - - Turning on the lock discards any unpublished editor changes on the deployment branch and force-syncs the editor with your Git repository. Publish or move pending edits to a draft branch before you enable the lock. - - -While the lock is on, incoming Git pushes to the deployment branch overwrite the editor's live state, so any in-flight edits on that branch are replaced by the latest commit. Use this setting when your team wants Git to remain the source of truth for the live site, and all editor changes to flow through pull requests from draft branches. -To edit while the deployment branch is locked, use the branch picker in the top bar to create or switch to a draft branch. You publish those changes by opening a pull request from your draft branch, the same as any other editor branch. ### Pull request instructions From e2430aa10b7a35f180d8d3b938b3320d58ee7296 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 13 Jul 2026 16:44:40 -0700 Subject: [PATCH 5/5] Apply suggestion from @ethanpalm --- editor/settings.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/editor/settings.mdx b/editor/settings.mdx index 0131ae31a..39ec7f246 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -59,13 +59,9 @@ You need admin access to your Mintlify deployment to change publishing settings. ### Lock the deployment branch -Turn this on to make your deployment branch (usually `main`) read-only in the editor. When the branch is locked: - - - - -Use this setting when your team wants Git to remain the source of truth for the live site, and all editor changes to flow through pull requests from draft branches. +To make your deployment branch (usually `main`) read-only in the editor, lock the deployment branch. +Use this setting when your team wants all editor changes to create pull requests from draft branches. ### Pull request instructions