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
39 changes: 35 additions & 4 deletions editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,47 @@
---
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"]
title: "Editor settings for layout, AI, and publishing"
description: "Configure your navigation layout, AI instructions, commit and pull request guidance, draft pull requests, and merge method for the web editor."
keywords: ["editor", "settings", "navigation", "layout", "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.
- **Your settings** apply only to you. They control the editor layout and 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.

## UI and appearance

UI and appearance settings are scoped to your user account. Changes apply across every deployment you open in the editor and sync to your other devices.

Check warning on line 16 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L16

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

Open **Settings** in the editor and select **UI & Appearance** to update these preferences.

### Navigation structure

Choose the default view for the left-hand navigation panel:

- **Docs navigation**: Shows pages grouped the same way they appear on your published site, using the structure defined in `docs.json`. Best when you think about your docs in terms of where readers find each page.
- **File tree**: Shows the underlying repository file system, including assets, snippets, and files that aren't part of `docs.json`. Best for repo-level tasks like renaming files or working with images.

You can still switch between views at any time from the sidebar — this setting only controls which view opens by default.

Check warning on line 27 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L27

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

### Fit editor to full width

Turn this on to let the editing canvas expand to fill the available horizontal space instead of keeping the default reading-width column.

Use full width when you're working with wide tables, large code blocks, or side-by-side components. Leave it off to match the line length readers see on your published site.

### Open live preview in a new tab

By default, the live preview opens as an overlay inside the dashboard. Turn this on to open the preview in a new browser tab instead.

A separate tab is useful when you want to:

- Keep the preview visible on a second monitor while you edit.
- Resize the preview window independently of the dashboard.
- Reload or share the preview URL without leaving 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.
Expand All @@ -20,7 +51,7 @@
- **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 54 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L54

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

### When to use AI instructions

Expand Down Expand Up @@ -54,7 +85,7 @@

## 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 88 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L88

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

Check warning on line 88 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L88

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

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

Expand Down Expand Up @@ -112,9 +143,9 @@

- **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 146 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L146

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 148 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L148

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.
Expand Down
47 changes: 43 additions & 4 deletions es/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,55 @@
---
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"]
title: "Configuración del editor para diseño, IA y publicación"
description: "Configura el diseño de navegación, las instrucciones de IA, las pautas de commits y pull requests, y el método de fusión del editor web."
keywords: ["editor", "configuración", "navegación", "diseño", "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.
- **Tu configuración** se aplica solo a ti. Controla el diseño del editor y 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="ui-and-appearance">
## Interfaz y apariencia
</div>

La configuración de interfaz y apariencia está asociada a tu cuenta de usuario. Los cambios se aplican a todos los deployments que abres en el editor y se sincronizan con tus otros dispositivos.

Abre **Settings** en el editor y selecciona **UI & Appearance** para actualizar estas preferencias.

<div id="navigation-structure">
### Estructura de navegación
</div>

Elige la vista predeterminada del panel de navegación izquierdo:

- **Docs navigation**: Muestra las páginas agrupadas igual que aparecen en tu sitio publicado, usando la estructura definida en `docs.json`. Ideal cuando piensas en tu documentación en función de dónde encuentran los lectores cada página.
- **File tree**: Muestra el sistema de archivos del repositorio, incluidos los recursos, snippets y archivos que no forman parte de `docs.json`. Ideal para tareas a nivel de repositorio, como renombrar archivos o trabajar con imágenes.

Puedes cambiar entre vistas en cualquier momento desde la barra lateral — esta opción solo controla qué vista se abre por defecto.

<div id="fit-editor-to-full-width">
### Ajustar el editor al ancho completo
</div>

Activa esta opción para que el lienzo de edición se expanda y ocupe todo el espacio horizontal disponible, en lugar de mantener la columna con ancho de lectura predeterminado.

Usa el ancho completo cuando trabajes con tablas anchas, bloques de código grandes o componentes uno al lado del otro. Déjalo desactivado para que coincida con la longitud de línea que ven los lectores en tu sitio publicado.

<div id="open-live-preview-in-a-new-tab">
### Abrir la vista previa en vivo en una pestaña nueva
</div>

Por defecto, la vista previa en vivo se abre como una superposición dentro del panel. Activa esta opción para abrir la vista previa en una pestaña nueva del navegador.

Una pestaña separada es útil cuando quieres:

- Mantener la vista previa visible en un segundo monitor mientras editas.
- Redimensionar la ventana de vista previa de forma independiente del panel.
- Recargar o compartir la URL de la vista previa sin salir del editor.

<div id="ai-instructions">
## Instrucciones de IA
</div>
Expand Down
47 changes: 43 additions & 4 deletions fr/editor/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,55 @@
---
title: "Paramètres de l'éditeur pour l'IA et la publication"
description: "Configurez les instructions d'IA, les consignes pour les commits et les pull requests, les pull requests en brouillon et la méthode de fusion par défaut de l'éditeur web Mintlify."
keywords: ["éditeur", "paramètres", "ai", "instructions", "publication", "pull request", "commit", "brouillon", "fusion"]
title: "Paramètres de l'éditeur pour la mise en page, l'IA et la publication"
description: "Configurez la mise en page de la navigation, les instructions d'IA, les consignes pour les commits et pull requests, et la méthode de fusion."
keywords: ["éditeur", "paramètres", "navigation", "mise en page", "ai", "instructions", "publication", "pull request", "commit", "brouillon", "fusion"]
---

L'éditeur web comporte deux niveaux de paramètres :

- **Vos paramètres** ne s'appliquent qu'à vous et contrôlent la façon dont l'IA de l'éditeur vous assiste pendant vos modifications.
- **Vos paramètres** ne s'appliquent qu'à vous. Ils contrôlent la mise en page de l'éditeur et la façon dont l'IA de l'éditeur vous assiste pendant vos modifications.
- **Les paramètres de publication** s'appliquent à toutes les personnes d'un déploiement et déterminent ce qui se passe lorsque les modifications sont committées puis transformées en pull requests.

Vous pouvez configurer les deux depuis le menu **Settings** de l'éditeur.

<div id="ui-and-appearance">
## Interface et apparence
</div>

Les paramètres d'interface et d'apparence sont liés à votre compte utilisateur. Les modifications s'appliquent à tous les déploiements que vous ouvrez dans l'éditeur et se synchronisent sur vos autres appareils.

Ouvrez **Settings** dans l'éditeur et sélectionnez **UI & Appearance** pour mettre à jour ces préférences.

<div id="navigation-structure">
### Structure de la navigation
</div>

Choisissez la vue par défaut du panneau de navigation gauche :

- **Docs navigation** : Affiche les pages regroupées de la même manière qu'elles apparaissent sur votre site publié, selon la structure définie dans `docs.json`. Idéal lorsque vous pensez à votre documentation en fonction de l'endroit où les lecteurs trouvent chaque page.
- **File tree** : Affiche le système de fichiers du dépôt, y compris les ressources, les snippets et les fichiers qui ne font pas partie de `docs.json`. Idéal pour les tâches au niveau du dépôt, comme renommer des fichiers ou travailler avec des images.

Vous pouvez à tout moment basculer entre les vues depuis la barre latérale — ce paramètre ne contrôle que la vue ouverte par défaut.

<div id="fit-editor-to-full-width">
### Ajuster l'éditeur en pleine largeur
</div>

Activez cette option pour que la zone d'édition s'étende sur tout l'espace horizontal disponible, au lieu de conserver la colonne de largeur de lecture par défaut.

Utilisez la pleine largeur lorsque vous travaillez avec de grands tableaux, de longs blocs de code ou des composants côte à côte. Laissez-la désactivée pour correspondre à la longueur de ligne que voient les lecteurs sur votre site publié.

<div id="open-live-preview-in-a-new-tab">
### Ouvrir l'aperçu en direct dans un nouvel onglet
</div>

Par défaut, l'aperçu en direct s'ouvre en superposition dans le tableau de bord. Activez cette option pour ouvrir l'aperçu dans un nouvel onglet du navigateur.

Un onglet séparé est utile lorsque vous voulez :

- Garder l'aperçu visible sur un second écran pendant que vous éditez.
- Redimensionner la fenêtre d'aperçu indépendamment du tableau de bord.
- Recharger ou partager l'URL de l'aperçu sans quitter l'éditeur.

<div id="ai-instructions">
## Instructions d'IA
</div>
Expand Down
Loading