Colaborar en el editor web

Edita la documentación con tu equipo mediante colaboración en tiempo real, cursores en vivo, enlaces compartibles del editor, branches y flujos de revisión con pull requests.

Colabora con tu equipo en la documentación usando edición en tiempo real y flujos de trabajo basados en branches.

​

Colaboración en tiempo real

Varias personas pueden editar la misma página al mismo tiempo. Los cambios de cada persona aparecen para todos los que están en la página.

Para colaborar en una página en tiempo real, comparte el enlace del editor de esa página con tus compañeros. Consulta Compartir enlaces del editor más abajo.

​

Cómo funciona la edición en tiempo real

Cuando varios miembros del equipo editan la misma branch, los cambios se sincronizan en tiempo real. Las actualizaciones de contenido de la página, la estructura de navegación y la configuración del sitio aparecen automáticamente para todos los colaboradores sin necesidad de actualizar.

• El cursor y las ediciones de cada persona son visibles para todos los que están en la página, con los avatares y nombres de los usuarios mostrados en la barra de herramientas.
• Los cambios se fusionan automáticamente. Que dos personas editen la misma sección no provoca conflictos.
• Deshacer solo afecta a tus propios cambios; deshacer no revierte las ediciones de otra persona.
• Si pierdes la conexión de red, tus ediciones se guardan localmente y se sincronizan cuando vuelves a conectarte.

​

Ver las ediciones del agente en tiempo real

Cuando el agente de Mintlify edita una página mediante la API o MCP, aparece en el editor web como cualquier otro colaborador. Si tienes la página abierta en la misma branch, verás el avatar y el nombre del agente en la parte superior del editor y un cursor en vivo en la ubicación de su edición más reciente.

Úsalo para:

• Ver cómo los cambios del agente se transmiten a la página en tiempo real.
• Saber qué párrafo o bloque acaba de actualizar el agente sin tener que hacer un diff del archivo.
• Coordinarte con tus compañeros y el agente en la misma branch sin sobrescribir el trabajo de los demás.

El cursor del agente se borra automáticamente poco después de que el agente termina de editar.

​

Colaboración basada en branches

Utiliza branches para trabajar en paralelo en actualizaciones de la documentación sin afectar tu sitio en producción. Si no conoces Git, consulta Conceptos básicos de Git para el editor web.

​

Por qué usar branches

• Aislar cambios: Trabaja en actualizaciones sin afectar tu documentación en producción.
• Revisar antes de publicar: Obtén comentarios del equipo antes de publicar los cambios.
• Trabajo en paralelo: Varios miembros del equipo pueden trabajar en diferentes branches al mismo tiempo.

​

Flujo de trabajo recomendado

Las solicitudes de extracción te permiten proponer cambios y colaborar con tu equipo antes de fusionarlos con tu documentación en producción. Este flujo de trabajo garantiza que tu equipo revise los cambios antes de publicarlos y mantiene un historial claro de actualizaciones.

1. Crear una solicitud de extracción

   Crea una solicitud de extracción desde el editor cuando estés listo para publicar tus cambios. Consulta Branching and publishing para obtener más información.

2. Revisar solicitudes de extracción

   Revisa las solicitudes de extracción en tu proveedor de Git como GitHub o GitLab.

3. Responder a los comentarios

   Cuando los revisores soliciten cambios, realiza los cambios solicitados en el editor. Los cambios adicionales se envían automáticamente a la solicitud de extracción existente.

4. Fusionar solicitudes de extracción

   Fusiona tu solicitud de extracción cuando se hayan abordado todos los cambios solicitados, los revisores obligatorios la hayan aprobado y se hayan superado todas las comprobaciones automatizadas.

​

Implementaciones de vista previa

Las implementaciones de vista previa crean URL temporales donde puedes ver tus cambios antes de que se publiquen. Usa las implementaciones de vista previa para recopilar comentarios sobre tus cambios.

Cada vez que publicas cambios en una branch, la implementación de vista previa se actualiza automáticamente.

​

Acceder a las implementaciones de vista previa

1. Haz clic en Publish en la barra de herramientas del editor.
2. Haz clic en la URL de vista previa para abrir la implementación de vista previa en una pestaña nueva. El formato de la URL es organization-branch-name.mintlify.app.

​

Compartir vistas previas

Comparte la URL de la implementación de vista previa con los miembros del equipo para recopilar comentarios. Las vistas previas se actualizan automáticamente cuando publicas cambios adicionales.

​

Autenticación en vista previa

Las URL de vista previa son de acceso público de forma predeterminada. Habilita la autenticación en vista previa en la página de Add-ons de tu dashboard para restringir el acceso a los miembros autenticados de la organización.

​

Compartir enlaces del editor

Comparte un enlace directo a una página específica del editor con tu equipo. Usa enlaces del editor para colaborar en actualizaciones en tiempo real o para dirigir a tus compañeros a una página específica.

La URL del editor se actualiza automáticamente a medida que navegas entre páginas. Copia la URL de la barra de direcciones de tu navegador para compartirla con los compañeros que tengan acceso al editor.

El formato de la URL es: https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}

Por ejemplo, https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx abre quickstart.mdx en la branch main.

Cualquier persona con acceso a tu organización de Mintlify puede usar el enlace para abrir el archivo directamente en el editor.