Documentation Index
Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Web 编辑器有两层设置：
- 个人设置仅对你生效，控制编辑器的 AI 在你编辑时如何提供协助。
- 发布设置对部署中的所有人生效，决定变更在被提交并转换为 pull request 时如何处理。
你可以在编辑器的 Settings 菜单中配置这两项。
AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。用它来固定你不想在每次提示中都重复的风格和语气规则，例如语气、术语或格式约定。
你的指令适用于：
- 对选中文本的 Edit with AI 操作，如改写、扩写或修正。
- 从编辑器中启动的 agent 会话。
指令的作用范围是你的用户账号，因此每位团队成员维护各自的指令。
当你发现自己在提示中反复给出相同的指引时，就应该添加 AI 指令，例如：
- 强制使用第二人称或句首大写式的标题。
- 优先使用特定的产品名称或术语。
- 禁用营销用语或填充性短语。
- 要求使用特定组件，例如始终使用
<Note> 表示提示。
保持指令简短而具体。AI 会在每次请求时遵循它们，模糊或相互矛盾的规则会降低效果。
- 打开编辑器，点击工具栏中的头像。
- 选择 Settings。
- 在 AI instructions 字段中输入希望 AI 遵循的指令。
- 保存更改。
示例：
- 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".
- Conventional Commits（
docs(editor): ...）。
- 必需的工单或 issue 前缀。
- 比默认 72 个字符更严格的标题长度上限。
示例：
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.
- 必需的小节，如 Summary 和 Changes。
- 链接到跟踪系统的描述模板。
- 对标题的语气或长度要求。
示例：
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.
- 你的团队要求在 pull request 开放审批前先进行一次人工审阅。
- 你希望分享预览 URL，但不希望传递”已准备好合并”的信号。
你仍然可以在 Git 提供商中将 pull request 标记为可审阅。
选择在你点击 Merge and publish 时编辑器使用的合并方式：
- Merge：创建一个合并提交，保留分支的完整历史。
- Squash：将分支上的所有提交合并为部署分支上的单个提交。
- Rebase：将分支上的每个提交逐个重放到部署分支，不产生合并提交。
所选方式将作为默认值。如果你通过 API 或 Git 提供商的界面显式传入合并方式，那种方式将优先生效。
请让默认合并方式与 Git 提供商的分支保护设置一致。如果你的部署分支只允许 squash 合并，请将默认值设为 Squash，以避免从编辑器合并失败。
