From f36e7888bb9c7d1c3a5e230ac8573caab2b2bd91 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 17:51:37 +0000 Subject: [PATCH] docs: document Auto publish mode and updated draft PR default --- editor/settings.mdx | 18 +++++++++++++----- es/editor/settings.mdx | 20 ++++++++++++++------ fr/editor/settings.mdx | 20 ++++++++++++++------ zh/editor/settings.mdx | 18 +++++++++++++----- 4 files changed, 54 insertions(+), 22 deletions(-) diff --git a/editor/settings.mdx b/editor/settings.mdx index 63bda28d5..085aff42d 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -82,23 +82,31 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -### Main branch autocommits +### Auto publish -When you enable main branch autocommits, the editor commits changes shortly after you stop typing. +Turn on **Auto publish** to skip branches and the publish step entirely. The editor commits changes directly to your deployment branch shortly after you stop typing, and those changes go live as soon as your site rebuilds. -Use this setting when your team edits the deployment branch directly and wants updates to reach Git without a manual publish step. If you want to review changes before they publish to your site, do not use autocommits. +While Auto publish is on: -Edits on feature branches created from the editor autocommit regardless of this setting. Changes on a feature branch never publish unless you merge them into your deployment branch. +- The branch selector and **Publish** button are hidden in the editor. +- Every edit lands on the deployment branch. There is no draft state and no review pass. +- Changes are live for all readers as soon as the commit deploys. + +Use Auto publish for wiki-style docs where speed matters more than review, or for a small team that wants edits to reach Git without opening a pull request. Leave it off if you want to review changes before they publish, or if your team relies on draft branches and preview URLs. + +If you previously used **Main branch autocommits**, your deployment is migrated to Auto publish with the same behavior — commits go straight to the deployment branch — and now with the publish step removed from the editor. ### Create pull requests as drafts by default -Turn this on to have the editor open every new pull request in draft state. You can't merge a draft pull request until you mark it ready for review. This is useful when: +When this is on, the editor opens every new pull request in draft state. You can't merge a draft pull request until you mark it ready for review. This is useful when: - Your team requires a manual review pass before a pull request is open for approval. - You want to share preview URLs without signaling that the change is ready to merge. You can still mark a pull request as ready for review from your Git provider. +New deployments have this setting on by default. Existing deployments keep whatever value you already had. + ### Default merge method Choose how the editor merges pull requests when you click **Merge and publish**: diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index aa386d9c2..ad3bff129 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -121,17 +121,23 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -
+
-### Autocommits en la rama principal +### Auto publish
-Active esta opción para que el editor confirme automáticamente los cambios realizados en la deployment branch (normalmente `main`) poco después de que deje de editar. Cuando está desactivada, los cambios en la deployment branch quedan pendientes en el editor hasta que los publique. +Active **Auto publish** para omitir por completo las branches y el paso de publicación. El editor confirma los cambios directamente en su deployment branch poco después de que deje de escribir, y esos cambios se publican tan pronto como su sitio se reconstruya. -Use esta opción cuando su equipo edita directamente la deployment branch y quiere que las actualizaciones lleguen a Git sin un paso de publicación manual. Déjela desactivada si prefiere revisar los cambios en el editor antes de que lleguen a la deployment branch. +Mientras Auto publish esté activado: -Esta opción solo afecta a la deployment branch. Las ediciones en branches de funcionalidades creadas desde el editor siguen confirmándose automáticamente sin importar este ajuste, y bloquear la deployment branch tiene prioridad. +- El selector de branches y el botón **Publish** se ocultan en el editor. +- Cada edición se guarda en la deployment branch. No hay estado de borrador ni pasada de revisión. +- Los cambios están en vivo para todos los lectores en cuanto se despliega el commit. + +Use Auto publish para documentación de tipo wiki en la que la velocidad importa más que la revisión, o para un equipo pequeño que quiera que las ediciones lleguen a Git sin abrir un pull request. Déjelo desactivado si quiere revisar los cambios antes de publicarlos o si su equipo usa branches de borrador y URLs de vista previa. + +Si antes usaba **Autocommits en la rama principal**, su deployment se migra a Auto publish con el mismo comportamiento — los commits van directos a la deployment branch — y ahora sin el paso de publicación en el editor.
@@ -139,13 +145,15 @@ Esta opción solo afecta a la deployment branch. Las ediciones en branches de fu
-Active esta opción para que el editor abra todos los pull requests nuevos en estado de borrador. No puede fusionar un pull request en borrador hasta que lo marque como listo para revisión. Esto es útil cuando: +Cuando esta opción está activada, el editor abre todos los pull requests nuevos en estado de borrador. No puede fusionar un pull request en borrador hasta que lo marque como listo para revisión. Esto es útil cuando: - Su equipo requiere una revisión manual antes de abrir el pull request para aprobación. - Quiere compartir URLs de vista previa sin indicar que el cambio está listo para fusionarse. Todavía puede marcar un pull request como listo para revisión desde su proveedor de Git. +Los deployments nuevos tienen esta opción activada por defecto. Los deployments existentes conservan el valor que ya tenían. +
### Método de fusión predeterminado diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index c02a1a051..a0d32e4a7 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -121,17 +121,23 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -
+
-### Autocommits sur la branche principale +### Auto publish
-Activez cette option pour que l'éditeur valide automatiquement les modifications apportées à la deployment branch (généralement `main`) peu après l'arrêt de la saisie. Lorsqu'elle est désactivée, les modifications sur la deployment branch restent en attente dans l'éditeur jusqu'à ce que vous les publiiez. +Activez **Auto publish** pour ignorer complètement les branches et l'étape de publication. L'éditeur valide les modifications directement sur votre deployment branch peu après l'arrêt de la saisie, et ces modifications deviennent visibles dès la reconstruction de votre site. -Utilisez ce paramètre lorsque votre équipe modifie directement la deployment branch et souhaite que les mises à jour arrivent dans Git sans étape de publication manuelle. Laissez-le désactivé si vous préférez revoir les modifications dans l'éditeur avant qu'elles n'atteignent la deployment branch. +Lorsque Auto publish est activé : -Ce paramètre ne concerne que la deployment branch. Les modifications sur les branches de fonctionnalités créées depuis l'éditeur continuent d'être validées automatiquement, et le verrouillage de la deployment branch est prioritaire. +- Le sélecteur de branches et le bouton **Publish** sont masqués dans l'éditeur. +- Chaque modification est enregistrée sur la deployment branch. Il n'y a pas d'état de brouillon ni d'étape de relecture. +- Les modifications sont en direct pour tous les lecteurs dès que le commit est déployé. + +Utilisez Auto publish pour une documentation de type wiki où la rapidité prime sur la relecture, ou pour une petite équipe qui veut que les modifications arrivent dans Git sans ouvrir de pull request. Laissez-le désactivé si vous voulez revoir les modifications avant qu'elles ne soient publiées, ou si votre équipe s'appuie sur les branches de brouillon et les URL de prévisualisation. + +Si vous utilisiez auparavant **Autocommits sur la branche principale**, votre déploiement est migré vers Auto publish avec le même comportement — les commits vont directement sur la deployment branch — et désormais sans l'étape de publication dans l'éditeur.
@@ -139,13 +145,15 @@ Ce paramètre ne concerne que la deployment branch. Les modifications sur les br
-Activez cette option pour que l'éditeur ouvre chaque nouvelle pull request à l'état de brouillon. Vous ne pouvez pas fusionner une pull request en brouillon avant de la marquer comme prête pour la relecture. C'est utile lorsque : +Lorsque cette option est activée, l'éditeur ouvre chaque nouvelle pull request à l'état de brouillon. Vous ne pouvez pas fusionner une pull request en brouillon avant de la marquer comme prête pour la relecture. C'est utile lorsque : - Votre équipe exige une relecture manuelle avant d'ouvrir la pull request pour approbation. - Vous voulez partager des URL de prévisualisation sans signaler que la modification est prête à être fusionnée. Vous pouvez toujours marquer une pull request comme prête pour la relecture depuis votre fournisseur Git. +Les nouveaux déploiements ont cette option activée par défaut. Les déploiements existants conservent la valeur que vous aviez déjà. +
### Méthode de fusion par défaut diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 4b0b4d69a..4a360efd8 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -110,15 +110,21 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -
- ### 主分支自动提交 +
+ ### 自动发布
-开启该选项后，编辑器会在你停止编辑后自动将部署分支（通常是 `main`）上的更改提交到 Git。关闭时，部署分支上的更改会在编辑器中保持挂起状态，直到你手动发布。 +开启 **Auto publish** 可完全跳过分支和发布步骤。编辑器会在你停止编辑后不久，直接将更改提交到部署分支，站点重新构建后这些更改即刻上线。 -当你的团队直接在部署分支上编辑，并希望更新在无需手动发布的情况下进入 Git 时，请启用此设置。如果你希望在更改进入部署分支之前先在编辑器中审阅，请保持关闭。 +当 Auto publish 处于开启状态时： -此设置仅影响部署分支。从编辑器创建的功能分支上的编辑无论此设置如何都会继续自动提交，并且锁定部署分支具有更高优先级。 +- 编辑器会隐藏分支选择器和 **Publish** 按钮。 +- 每次编辑都会写入部署分支。没有草稿状态，也没有审阅环节。 +- 提交部署后，所有读者立刻能看到更改。 + +当你的文档是 wiki 风格、更看重速度而非审阅，或者小团队希望更改直接进入 Git 而不用打开 pull request 时，请使用 Auto publish。如果你希望在更改发布前进行审阅，或团队依赖草稿分支和预览 URL，请保持关闭。 + +如果你之前使用 **主分支自动提交**，你的 deployment 会被迁移到 Auto publish，行为保持一致——提交直接进入部署分支——只是编辑器中不再有发布步骤。
### 默认以草稿形式创建 pull request @@ -131,6 +137,8 @@ using its relative path. 你仍然可以在 Git 提供商中将 pull request 标记为可审阅。 +新的 deployment 默认开启此设置。现有 deployment 保留你原有的取值。 +
### 默认合并方式