Saltar al contenido principal
El editor web tiene dos capas de configuración:
  • Su configuración se aplica solo a usted y controla cómo la IA del editor le ayuda con sus ediciones.
  • La configuración de publicación se aplica a todos en un deployment y determina qué sucede cuando confirma cambios y los convierte en pull requests.
Puede configurar ambas desde el panel de configuración. Para abrirlo, haga clic en el icono de configuración en la barra de herramientas del editor.

Instrucciones de IA

Las instrucciones de IA son pautas persistentes que el editor envía a la IA junto con su solicitud. Úselas para capturar reglas de estilo y tono que no quiere repetir cada vez, como voz, terminología o convenciones de formato. Sus instrucciones se aplican a:
  • Acciones Edit with AI sobre una selección, como reescribir, ampliar o corregir.
  • Sesiones del agente iniciadas desde el editor.
Cada compañero de equipo mantiene sus propias instrucciones, asociadas a su cuenta de usuario.

Cuándo usar las instrucciones de IA

Añada instrucciones de IA cuando se descubra repitiendo las mismas pautas en los prompts, por ejemplo:
  • Imponer 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.
Mantenga 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. Haga clic en el icono de configuración en la barra de herramientas del editor.
  2. En el campo AI instructions, introduzca las pautas que quiere que siga la IA.
  3. Guarde sus cambios.
Ejemplo:
Deje el campo vacío para eliminar sus 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 el editor genera, abre y fusiona pull requests y commits. Necesita acceso de administrador a su deployment de Mintlify para cambiar la configuración de publicación.

Bloquear la rama de despliegue

Actívalo para que tu rama de despliegue (normalmente main) sea de solo lectura en el editor. Cuando la rama está bloqueada:
  • El editor y la vista de código fuente pasan a solo lectura para cualquier persona que esté viendo la rama de despliegue.
  • El panel de configuración de docs.json deja de guardar cambios.
  • Las ediciones de navegación —agregar páginas, reordenar y arrastrar y soltar— se ocultan.
  • Un aviso pide a los colaboradores que creen una rama borrador antes de hacer ediciones.
Tu rama de despliegue permanece sincronizada con Git, por lo que los push desde tu repositorio siguen actualizando tu sitio en producción. El bloqueo solo afecta a las ediciones realizadas desde el editor.
Activar el bloqueo descarta cualquier edición del editor sin publicar en la rama de despliegue y fuerza la sincronización del editor con tu repositorio de Git. Publica las ediciones pendientes o muévelas a una rama borrador antes de activar el bloqueo.
Mientras el bloqueo esté activo, los push entrantes de Git a la rama de despliegue sobrescriben el estado en vivo del editor, por lo que cualquier edición en curso en esa rama se reemplaza con el último commit. Usa este ajuste cuando tu equipo quiera que Git siga siendo la fuente de verdad del sitio en producción, y que todos los cambios del editor pasen por pull requests desde ramas borrador. Para editar mientras la rama de despliegue está bloqueada, usa el selector de ramas en la barra superior para crear una rama borrador o cambiarte a una. Publica esos cambios abriendo un pull request desde tu rama borrador, igual que con cualquier otra rama del editor.

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 su nombre, incluyendo los flujos Create pull request y Merge and publish. Use 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:

Crear pull requests como borradores por defecto

Active esta opción para que el editor abra todos los pull requests nuevos en estado de borrador. No puede fusionar un pull request en borrador hasta que lo marque como listo para revisión. Esto es útil cuando:
  • Su equipo requiere una revisión manual antes de abrir el pull request para aprobación.
  • Quiere compartir URLs de vista previa sin indicar que el cambio está listo para fusionarse.
Todavía puede marcar un pull request como listo para revisión desde su proveedor de Git.

Método de fusión predeterminado

Elija cómo fusiona el editor los pull requests cuando hace clic en Merge and publish:
  • Merge: Crea un commit de fusión que preserva el historial completo de la branch.
  • Squash: Combina todos los commits de la branch en un único commit en su deployment branch.
  • Rebase: Reproduce cada commit de la branch sobre su deployment branch sin crear un commit de fusión.
El editor usa el método seleccionado por defecto. Si pasa un método de fusión explícito a través de la API o de la interfaz de su proveedor de Git, esa elección tiene prioridad.
Ajuste su método de fusión predeterminado a las reglas de protección de branches de su proveedor de Git. Si su deployment branch solo permite fusiones tipo squash, configure el valor predeterminado en Squash para evitar fusiones fallidas desde el editor.

Danger zone

La sección Danger zone del panel de configuración del editor contiene acciones que no se pueden deshacer. Ábrala desde el icono de configuración en la barra de herramientas del editor y desplácese hasta Danger zone.

Reset editor

Reset editor obliga al editor a descartar su estado local y volver a sincronizarse desde su repositorio de Git. Úselo cuando el editor se quede desincronizado con su repositorio — por ejemplo, cuando el árbol de archivos está vacío o muestra errores como Unable to find docs.json or mint.json aunque el archivo exista en su deployment branch y su sitio en producción se compile con normalidad.
Restablecer el editor descarta cualquier cambio no publicado que no se haya confirmado en Git. Si tiene ediciones pendientes que quiere conservar, publíquelas primero.
Para restablecer el editor:
  1. Haga clic en el icono de configuración en la barra de herramientas del editor.
  2. Desplácese hasta Danger zone.
  3. Haga clic en Reset editor y confirme.
El editor se recarga y descarga el último estado desde su repositorio.
La acción Reset editor se encuentra en el panel de configuración del editor, no en la Danger zone de la configuración de su dashboard. La Danger zone del dashboard solo se usa para eliminar un deployment.