Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-docs-editor-ui-appearance-settings.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

El editor web tiene dos capas de configuración:
  • 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.

​
Interfaz y apariencia

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

​
Ajustar el editor al ancho completo

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.

​
Abrir la vista previa en vivo en una pestaña nueva

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.

​
Instrucciones de IA

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.

​
Cuándo usar las instrucciones de IA

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.

​
Configurar las instrucciones de IA

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

​
Configuración de publicación

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.

​
Instrucciones para el mensaje de commit

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

​
Instrucciones para el pull request

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

​
Crear pull requests como borradores por defecto

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.

​
Método de fusión predeterminado

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