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
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@
"editor/pages",
"editor/navigation",
"editor/keyboard-shortcuts",
"editor/configurations"
"editor/configurations",
"editor/settings"
]
},
"editor-classic",
Expand Down
126 changes: 126 additions & 0 deletions editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
title: "Editor settings for AI and publishing"
description: "Configure AI instructions, commit and pull request guidance, draft pull requests, and the default merge method for the Mintlify web editor."
keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "commit", "draft", "merge"]
---

The web editor has two layers of settings:

- **Your settings** apply only to you and control how the editor's AI assists with your edits.
- **Publishing settings** apply to everyone on a deployment and shape what happens when changes are committed and turned into pull requests.

Check warning on line 10 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L10

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

You can configure both from the **Settings** menu in the editor.

## AI instructions

AI instructions are persistent guidance that the editor sends to the AI alongside your request. Use them to capture style and tone rules you don't want to repeat every time, like voice, terminology, or formatting conventions.

Your instructions apply to:

- **Edit with AI** actions on a selection, such as rewrite, expand, or fix.
- **Agent sessions** started from the editor.

Instructions are scoped to your user account, so each teammate maintains their own.

Check warning on line 23 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L23

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

### When to use AI instructions

Add AI instructions when you find yourself repeating the same guidance in prompts, for example:

- Enforcing second-person voice or sentence case headings.
- Preferring specific product names or terminology.
- Banning marketing language or filler phrases.
- Requiring certain components, like always using `<Note>` for callouts.

Keep instructions short and specific. The AI follows them on every request, so vague or contradictory rules degrade results.

### Configure AI instructions

1. Open the editor and click your avatar in the toolbar.
2. Select **Settings**.
3. In the **AI instructions** field, enter the guidance you want the AI to follow.
4. Save your changes.

Example:

```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".
```

Leave the field empty to remove your instructions.

## Publishing settings

Publishing settings are configured per deployment and apply to everyone who publishes from the editor. They control how pull requests and commits are generated, opened, and merged.

Check warning on line 57 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L57

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

Check warning on line 57 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L57

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

You need admin access to your Mintlify deployment to change publishing settings.

### Commit message instructions

Commit message instructions guide the AI when it generates a commit message for a publish. The editor uses them whenever you publish without typing your own message.

Use commit message instructions to match an existing convention in your repository, for example:

- Conventional Commits (`docs(editor): ...`).
- A required ticket or issue prefix.
- A maximum subject length stricter than the 72-character default.

Example:

```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.
```

If your repository enforces a commit message regex, the editor still validates against it after generation.

### 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.

Use pull request instructions to standardize what reviewers see, for example:

- Required sections like **Summary** and **Changes**.
- A description template that links to a tracking system.
- Tone or length requirements for titles.

Example:

```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.
```

### 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:

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

### Default merge method

Choose how the editor merges pull requests when you click **Merge and publish**:

- **Merge**: Creates a merge commit that preserves the full branch history.
- **Squash**: Combines all commits in the branch into a single commit on your deployment branch.
- **Rebase**: Replays each commit from the branch onto your deployment branch without a merge commit.

Check warning on line 115 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L115

Did you really mean 'Rebase'?

The selected method is used by default. If you pass an explicit merge method through the API or your Git provider's UI, that choice takes precedence.

Check warning on line 117 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L117

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

<Tip>
Match your default merge method to your Git provider's branch protection settings. If your deployment branch only allows squash merges, set the default to **Squash** to avoid failed merges from the editor.
</Tip>

## Related

- [Branching and publishing](/editor/branching-and-publishing)
- [Configurations](/editor/configurations)
3 changes: 2 additions & 1 deletion es.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
"es/editor/live-preview",
"es/editor/collaborate",
"es/editor/publish",
"es/editor/keyboard-shortcuts"
"es/editor/keyboard-shortcuts",
"es/editor/settings"
]
},
"es/create/text",
Expand Down
144 changes: 144 additions & 0 deletions es/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
title: "Configuración del editor para IA y publicación"
description: "Configura las instrucciones de IA, las pautas para commits y pull requests, los pull requests en borrador y el método de fusión predeterminado del editor web de Mintlify."
keywords: ["editor", "configuración", "ai", "instrucciones", "publicación", "pull request", "commit", "borrador", "fusión"]
---

El editor web tiene dos capas de configuración:

- **Tu configuración** se aplica solo a ti y controla cómo la IA del editor te ayuda con tus ediciones.
- **La configuración de publicación** se aplica a todos los miembros de un deployment y determina qué sucede cuando los cambios se confirman y se convierten en pull requests.

Puedes configurar ambas desde el menú **Settings** en el editor.

<div id="ai-instructions">
## Instrucciones de IA
</div>

Las instrucciones de IA son pautas persistentes que el editor envía a la IA junto con tu solicitud. Úsalas para capturar reglas de estilo y tono que no quieres repetir cada vez, como la voz, la terminología o las convenciones de formato.

Tus instrucciones se aplican a:

- Acciones **Edit with AI** sobre una selección, como reescribir, ampliar o corregir.
- **Sesiones del agente** iniciadas desde el editor.

Las instrucciones están asociadas a tu cuenta de usuario, por lo que cada compañero de equipo mantiene las suyas.

<div id="when-to-use-ai-instructions">
### Cuándo usar las instrucciones de IA
</div>

Agrega instrucciones de IA cuando notes que repites las mismas pautas en los prompts, por ejemplo:

- Obligar el uso de la segunda persona o encabezados en mayúscula inicial.
- Preferir nombres de producto o terminología específicos.
- Prohibir lenguaje de marketing o frases de relleno.
- Exigir ciertos componentes, como usar siempre `<Note>` para los avisos.

Mantén las instrucciones cortas y específicas. La IA las sigue en cada solicitud, así que las reglas vagas o contradictorias degradan los resultados.

<div id="configure-ai-instructions">
### Configurar las instrucciones de IA
</div>

1. Abre el editor y haz clic en tu avatar en la barra de herramientas.
2. Selecciona **Settings**.
3. En el campo **AI instructions**, introduce las pautas que quieres que siga la IA.
4. Guarda los cambios.

Ejemplo:

```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".
```

Deja el campo vacío para eliminar tus instrucciones.

<div id="publishing-settings">
## Configuración de publicación
</div>

La configuración de publicación se establece por deployment y se aplica a todas las personas que publican desde el editor. Controla cómo se generan, se abren y se fusionan los pull requests y los commits.

Necesitas acceso de administrador a tu deployment de Mintlify para cambiar la configuración de publicación.

<div id="commit-message-instructions">
### Instrucciones para el mensaje de commit
</div>

Las instrucciones para el mensaje de commit guían a la IA cuando genera un mensaje de commit para una publicación. El editor las usa siempre que publicas sin escribir tu propio mensaje.

Usa las instrucciones para el mensaje de commit para que coincidan con una convención existente en tu repositorio, por ejemplo:

- Conventional Commits (`docs(editor): ...`).
- Un prefijo obligatorio de ticket o de issue.
- Una longitud máxima del asunto más estricta que el valor predeterminado de 72 caracteres.

Ejemplo:

```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.
```

Si tu repositorio aplica una expresión regular al mensaje de commit, el editor sigue validándola después de la generación.

<div id="pull-request-instructions">
### Instrucciones para el pull request
</div>

Las instrucciones para el pull request guían a la IA cuando genera el título y la descripción de un pull request. Se aplican siempre que el editor abre un pull request en tu nombre, incluyendo los flujos **Create pull request** y **Merge and publish**.

Usa las instrucciones para el pull request para estandarizar lo que ven los revisores, por ejemplo:

- Secciones obligatorias como **Summary** y **Changes**.
- Una plantilla de descripción que enlace con un sistema de seguimiento.
- Requisitos de tono o de longitud para los títulos.

Ejemplo:

```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">
### Crear pull requests como borradores por defecto
</div>

Activa esta opción para que el editor abra todos los pull requests nuevos en estado de borrador. No puedes fusionar un pull request en borrador hasta que lo marques como listo para revisión. Esto es útil cuando:

- Tu equipo requiere una revisión manual antes de abrir el pull request para aprobación.
- Quieres compartir URLs de vista previa sin indicar que el cambio está listo para fusionarse.

Todavía puedes marcar un pull request como listo para revisión desde tu proveedor de Git.

<div id="default-merge-method">
### Método de fusión predeterminado
</div>

Elige cómo fusiona el editor los pull requests cuando haces clic en **Merge and publish**:

- **Merge**: Crea un commit de fusión que preserva el historial completo de la rama.
- **Squash**: Combina todos los commits de la rama en un único commit en tu rama de deployment.
- **Rebase**: Reproduce cada commit de la rama sobre tu rama de deployment sin crear un commit de fusión.

El método seleccionado se usa por defecto. Si pasas un método de fusión explícito a través de la API o de la interfaz de tu proveedor de Git, esa elección tiene prioridad.

<Tip>
Ajusta tu método de fusión predeterminado a las reglas de protección de ramas de tu proveedor de Git. Si tu rama de deployment solo permite fusiones tipo squash, configura el valor predeterminado en **Squash** para evitar fusiones fallidas desde el editor.
</Tip>

<div id="related">
## Relacionado
</div>

- [Publicación](/es/editor/publish)
- [Configuraciones](/es/editor/configurations)
3 changes: 2 additions & 1 deletion fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
"fr/editor/live-preview",
"fr/editor/collaborate",
"fr/editor/publish",
"fr/editor/keyboard-shortcuts"
"fr/editor/keyboard-shortcuts",
"fr/editor/settings"
]
},
"fr/create/text",
Expand Down
Loading
Loading