Skip to content
Merged
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
235 changes: 115 additions & 120 deletions changelog.mdx

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
"light": "#26BD6C",
"dark": "#166E3F"
},
"favicon": "/favicon.ico",
"favicon": {
"light": "/favicon.ico",
"dark": "/favicon.ico"
},
"icons": {
"library": "lucide"
},
Expand Down
30 changes: 30 additions & 0 deletions es/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@ rss: true
noindex: true
---

<Update label="May 15, 2026" tags={["New releases", "Improvements"]} rss={{ title: "Instrucciones de IA y controles de publicación del editor" }}>

<div id="editor-settings-for-ai-and-publishing">
## Configuración del editor para IA y publicación
</div>

El editor web ahora tiene un menú **Settings** dedicado con dos niveles de configuración:

- **Tu configuración** está vinculada a tu cuenta y define cómo la IA del editor te asiste en tus ediciones.
- **Configuración de publicación** se establece por deployment por un administrador y define cómo se generan y combinan los commits y las pull requests.

Consulta [Configuración del editor para IA y publicación](/es/editor/settings) para ver la referencia completa.

<div id="new-features">
## Nuevas funcionalidades
</div>

- **Instrucciones de IA**: añade orientación persistente que el editor envía a la IA en cada acción **Edit with AI** y sesión del agente. Úsalo para fijar la voz, la terminología, las preferencias de componentes o las reglas de formato y no tener que repetirlas en cada prompt.
- **Instrucciones de mensajes de commit**: guían a la IA cuando genera mensajes de commit al publicar — útil para ajustarte a Conventional Commits, prefijos de ticket o límites de longitud más estrictos para el asunto.
- **Instrucciones de pull request**: estandariza los títulos y descripciones de pull requests generados por la IA cada vez que el editor abre una pull request, incluidos los flujos **Create pull request** y **Merge and publish**.

<div id="improvements">
## Mejoras
</div>

- **Pull requests en borrador por defecto**: los administradores pueden configurar el editor para abrir cada nueva pull request como borrador, de modo que los revisores vean una señal clara de "aún no está lista" hasta que la marques como lista para revisión.
- **Método de merge por defecto**: elige **Merge**, **Squash** o **Rebase** como predeterminado para **Merge and publish**. Ajústalo a las reglas de protección de rama de tu proveedor de Git para evitar merges fallidos desde el editor.

</Update>

<Update label="May 1, 2026" tags={["New releases", "Improvements"]} rss={{ title: "Conexiones del agente" }}>

<div id="agent-connections">
Expand Down
30 changes: 30 additions & 0 deletions fr/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@ rss: true
noindex: true
---

<Update label="15 mai 2026" tags={["Nouvelles versions", "Améliorations"]} rss={{ title: "Instructions d'IA et contrôles de publication de l'éditeur" }}>

<div id="editor-settings-for-ai-and-publishing">
## Paramètres de l'éditeur pour l'IA et la publication
</div>

L'éditeur web dispose désormais d'un menu **Settings** dédié avec deux niveaux de configuration :

- **Vos paramètres** sont liés à votre compte et déterminent comment l'IA de l'éditeur vous assiste lors de vos modifications.
- **Paramètres de publication** sont configurés par déploiement par un administrateur et déterminent comment les commits et les pull requests sont générés et fusionnés.

Consultez [Paramètres de l'éditeur pour l'IA et la publication](/fr/editor/settings) pour la référence complète.

<div id="new-features">
## Nouvelles fonctionnalités
</div>

- **Instructions d'IA** : ajoutez des consignes persistantes que l'éditeur envoie à l'IA à chaque action **Edit with AI** et session de l'agent. Utilisez-les pour fixer le ton, la terminologie, les préférences de composants ou les règles de mise en forme et éviter de les répéter dans chaque prompt.
- **Instructions pour les messages de commit** : guident l'IA lorsqu'elle génère des messages de commit à la publication — utile pour respecter Conventional Commits, des préfixes de ticket ou une longueur de sujet plus stricte.
- **Instructions pour les pull requests** : standardisez les titres et descriptions de pull requests générés par l'IA à chaque fois que l'éditeur ouvre une pull request, y compris depuis les flux **Create pull request** et **Merge and publish**.

<div id="improvements">
## Améliorations
</div>

- **Pull requests en brouillon par défaut** : les administrateurs peuvent configurer l'éditeur pour ouvrir chaque nouvelle pull request en brouillon, afin que les relecteurs voient un signal clair de "pas encore prêt" jusqu'à ce que vous la marquiez prête à être examinée.
- **Méthode de fusion par défaut** : choisissez **Merge**, **Squash** ou **Rebase** comme méthode par défaut pour **Merge and publish**. Alignez-la sur les règles de protection de branche de votre fournisseur Git pour éviter les fusions échouées depuis l'éditeur.

</Update>

<Update label="1er mai 2026" tags={["Nouvelles versions", "Améliorations"]} rss={{ title: "Connexions de l'agent" }}>

<div id="agent-connections">
Expand Down
3 changes: 2 additions & 1 deletion zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
"zh/editor/live-preview",
"zh/editor/collaborate",
"zh/editor/publish",
"zh/editor/keyboard-shortcuts"
"zh/editor/keyboard-shortcuts",
"zh/editor/settings"
]
},
"zh/create/text",
Expand Down
30 changes: 30 additions & 0 deletions zh/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@ rss: true
noindex: true
---

<Update label="May 15, 2026" tags={["New releases", "Improvements"]} rss={{ title: "编辑器 AI 指令与发布控制" }}>

<div id="editor-settings-for-ai-and-publishing">
## 用于 AI 与发布的编辑器设置
</div>

Web 编辑器现在提供独立的 **Settings** 菜单,包含两层配置:

- **个人设置**绑定到你的账号,决定编辑器的 AI 在你编辑时如何提供协助。
- **发布设置**由管理员按部署进行配置,决定提交和 pull request 的生成与合并方式。

详见 [用于 AI 与发布的编辑器设置](/zh/editor/settings)。

<div id="new-features">
## 新功能
</div>

- **AI 指令**:添加持续生效的指令,编辑器会在每次 **Edit with AI** 操作和 agent 会话中将其发送给 AI。可用于固定语气、术语、组件偏好或格式规则,避免在每个 prompt 中重复说明。
- **提交信息指令**:在发布时引导 AI 生成提交信息——适合匹配 Conventional Commits、工单前缀或更严格的标题长度规范。
- **Pull request 指令**:标准化编辑器在打开 pull request(包括 **Create pull request** 与 **Merge and publish** 流程)时由 AI 生成的标题和描述。

<div id="improvements">
## 改进
</div>

- **默认以草稿形式创建 pull request**:管理员可以将编辑器配置为以草稿方式打开每个新建的 pull request,让审阅者在你将其标记为可审阅前看到清晰的"尚未就绪"信号。
- **默认合并方式**:为 **Merge and publish** 选择默认使用 **Merge**、**Squash** 或 **Rebase**。请与你的 Git 提供商分支保护规则保持一致,避免从编辑器合并失败。

</Update>

<Update label="May 1, 2026" tags={["New releases", "Improvements"]} rss={{ title: "Agent 连接" }}>

<div id="agent-connections">
Expand Down
144 changes: 144 additions & 0 deletions zh/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
title: "用于 AI 与发布的编辑器设置"
description: "为 Mintlify Web 编辑器配置 AI 指令、提交和 pull request 指引、草稿 pull request 以及默认合并方式。"
keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "提交", "草稿", "合并"]
---

Web 编辑器有两层设置:

- **个人设置**仅对你生效,控制编辑器的 AI 在你编辑时如何提供协助。
- **发布设置**对部署中的所有人生效,决定变更在被提交并转换为 pull request 时如何处理。

你可以在编辑器的 **Settings** 菜单中配置这两项。

<div id="ai-instructions">
## AI 指令
</div>

AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。用它来固定你不想在每次提示中都重复的风格和语气规则,例如语气、术语或格式约定。

你的指令适用于:

- 对选中文本的 **Edit with AI** 操作,如改写、扩写或修正。
- 从编辑器中启动的 **agent 会话**。

指令的作用范围是你的用户账号,因此每位团队成员维护各自的指令。

<div id="when-to-use-ai-instructions">
### 何时使用 AI 指令
</div>

当你发现自己在提示中反复给出相同的指引时,就应该添加 AI 指令,例如:

- 强制使用第二人称或句首大写式的标题。
- 优先使用特定的产品名称或术语。
- 禁用营销用语或填充性短语。
- 要求使用特定组件,例如始终使用 `<Note>` 表示提示。

保持指令简短而具体。AI 会在每次请求时遵循它们,模糊或相互矛盾的规则会降低效果。

<div id="configure-ai-instructions">
### 配置 AI 指令
</div>

1. 打开编辑器,点击工具栏中的头像。
2. 选择 **Settings**。
3. 在 **AI instructions** 字段中输入希望 AI 遵循的指令。
4. 保存更改。

示例:

```text
- Use second person ("you") and active voice.
- Use sentence case for all headings.
- Refer to the product as "Acme" — never "Acme Inc." or "the platform".
- Wrap notes and warnings in <Note> or <Warning> components.
- Do not add introductory filler like "In this guide" or "Let's explore".
```

将该字段留空以移除你的指令。

<div id="publishing-settings">
## 发布设置
</div>

发布设置按部署进行配置,对所有从编辑器发布的人都生效。它们控制 pull request 和提交的生成、打开和合并方式。

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

<div id="commit-message-instructions">
### 提交信息指令
</div>

提交信息指令用于在发布时引导 AI 生成提交信息。每当你在发布时未自行填写提交信息,编辑器都会使用这些指令。

使用提交信息指令以匹配仓库中的现有约定,例如:

- Conventional Commits(`docs(editor): ...`)。
- 必需的工单或 issue 前缀。
- 比默认 72 个字符更严格的标题长度上限。

示例:

```text
Follow Conventional Commits. Use the "docs" type and an "editor" scope
for content changes (for example, "docs(editor): clarify quickstart steps").
Keep the subject under 60 characters.
```

如果你的仓库对提交信息强制使用正则表达式校验,编辑器在生成后仍会按该正则进行验证。

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

Pull request 指令用于在 AI 生成 pull request 标题和描述时进行引导。每当编辑器代你打开 pull request 时都会应用,包括 **Create pull request** 和 **Merge and publish** 流程。

使用 pull request 指令来标准化审阅者看到的内容,例如:

- 必需的小节,如 **Summary** 和 **Changes**。
- 链接到跟踪系统的描述模板。
- 对标题的语气或长度要求。

示例:

```text
Title: imperative mood, under 70 characters, no trailing period.
Description: include a "## Summary" section (one sentence) and a
"## Changes" section as a bulleted list. Link any referenced page
using its relative path.
```

<div id="create-pull-requests-as-drafts-by-default">
### 默认以草稿形式创建 pull request
</div>

开启该选项后,编辑器会以草稿状态打开每个新的 pull request。在将草稿 pull request 标记为可审阅之前,无法将其合并。该功能在以下场景中很有用:

- 你的团队要求在 pull request 开放审批前先进行一次人工审阅。
- 你希望分享预览 URL,但不希望传递"已准备好合并"的信号。

你仍然可以在 Git 提供商中将 pull request 标记为可审阅。

<div id="default-merge-method">
### 默认合并方式
</div>

选择在你点击 **Merge and publish** 时编辑器使用的合并方式:

- **Merge**:创建一个合并提交,保留分支的完整历史。
- **Squash**:将分支上的所有提交合并为部署分支上的单个提交。
- **Rebase**:将分支上的每个提交逐个重放到部署分支,不产生合并提交。

所选方式将作为默认值。如果你通过 API 或 Git 提供商的界面显式传入合并方式,那种方式将优先生效。

<Tip>
请让默认合并方式与 Git 提供商的分支保护设置一致。如果你的部署分支只允许 squash 合并,请将默认值设为 **Squash**,以避免从编辑器合并失败。
</Tip>

<div id="related">
## 相关内容
</div>

- [发布](/zh/editor/publish)
- [配置](/zh/editor/configurations)
Loading