Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -57,6 +57,27 @@

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:

Check warning on line 62 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L62

In general, use active voice instead of passive voice ('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.

Check warning on line 66 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L66

Don't put a space before or after a dash.

Check warning on line 66 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L66

In general, use active voice instead of passive voice ('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.

<Warning>
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.
</Warning>

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.

Check warning on line 75 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L75

In general, use active voice instead of passive voice ('are replaced').

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.

Check warning on line 79 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L79

In general, use active voice instead of passive voice ('is locked').

### 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.
Expand Down Expand Up @@ -108,7 +129,7 @@
**Reset editor** forces the editor to discard its local state and sync with your Git repository. If the editor gets stuck out of sync with your repo, reset the editor. For example, if the file tree is empty or shows errors like `Unable to find docs.json` even though the file exists on your deployment branch and your live site builds normally.

<Warning>
If you reset the editor, you discard any unpublished changes that haven't been committed to Git. If you have pending edits you want to keep, publish them first.

Check warning on line 132 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L132

In general, use active voice instead of passive voice ('been committed').
</Warning>

To reset the editor:
Expand Down
27 changes: 26 additions & 1 deletion es/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -73,6 +73,31 @@ 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.

<div id="lock-the-deployment-branch">

### Bloquear la rama de despliegue

</div>

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.

<Warning>
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.
</Warning>

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.

<div id="pull-request-instructions">

### Instrucciones para el pull request
Expand Down
27 changes: 26 additions & 1 deletion fr/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -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 :
Expand Down Expand Up @@ -73,6 +73,31 @@ 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.

<div id="lock-the-deployment-branch">

### Verrouiller la branche de déploiement

</div>

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.

<Warning>
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.
</Warning>

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.

<div id="pull-request-instructions">

### Instructions pour la pull request
Expand Down
25 changes: 24 additions & 1 deletion zh/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "用于 AI 与发布的编辑器设置"
description: "配置 AI 指令、pull request 默认值、草稿行为以及默认合并方式,以控制 Mintlify Web 编辑器发布变更的方式。"
keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "草稿", "合并"]
keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "草稿", "合并", "锁定分支"]
---

Web 编辑器有两层设置:
Expand Down Expand Up @@ -66,6 +66,29 @@ AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。

你需要拥有 Mintlify 部署的管理员权限才能更改发布设置。

<div id="lock-the-deployment-branch">
### 锁定部署分支
</div>

启用此选项可将你的部署分支(通常是 `main`)在编辑器中设为只读。分支被锁定后:

- 对于查看部署分支的所有人,编辑器和源代码视图都变为只读。
- `docs.json` 配置面板停止保存更改。
- 导航编辑(添加页面、重新排序和拖放)会被隐藏。
- 横幅会提示贡献者先创建草稿分支再进行编辑。

你的部署分支仍与 Git 保持同步,因此从仓库推送仍会更新线上站点。锁定只影响在编辑器中所做的更改。

<Warning>
开启锁定会丢弃部署分支上所有未发布的编辑器更改,并强制将编辑器与你的 Git 仓库重新同步。在开启锁定之前,请先发布待处理的编辑,或将其移动到草稿分支。
</Warning>

在锁定开启期间,向部署分支推送的 Git 提交会覆盖编辑器的实时状态,因此该分支上任何进行中的编辑都会被最新的提交替换。

当你的团队希望 Git 继续作为线上站点的唯一可信来源,并让所有编辑器更改都通过从草稿分支发起的 pull request 提交时,可使用此设置。

在部署分支被锁定时进行编辑,请使用顶栏中的分支选择器创建或切换到草稿分支。像其他编辑器分支一样,从你的草稿分支发起 pull request 即可发布这些更改。

<div id="pull-request-instructions">
### Pull request 指令
</div>
Expand Down
Loading