Colabora en la documentación con tu equipo mediante branches, solicitudes de extracción, implementaciones de vista previa y enlaces del editor para compartir.
Colabora con tu equipo en la documentación mediante flujos de trabajo basados en branches, solicitudes de extracción e implementaciones de vista previa.Si no conoces Git, consulta Conceptos de Git.
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 Publicar cambios en el editor web para obtener más información sobre el uso de solicitudes de extracció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 y guarda tus cambios. Se actualizarán automáticamente en 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, la solicitud de extracción haya sido aprobada por los revisores obligatorios y se hayan superado todas las comprobaciones automatizadas.
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 los cambios.
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 guardas cambios adicionales.
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.
Comparte un enlace directo a una página específica del editor con tu equipo. Usa enlaces del editor para colaborar en las actualizaciones y realizar cambios en las páginas.Cuando abres una página, el editor guarda la ruta de la página en la URL. Copia la URL de la barra de direcciones de tu navegador para compartirla con los miembros del equipo que tienen acceso al editor.El formato de la URL es:
Por ejemplo, https://dashboard.mintlify.com/acme/docs/editor/main?file=guides/quickstart.mdx abre quickstart.mdx en la rama main.Cualquier persona con acceso a tu organización de Mintlify puede usar el enlace para abrir el archivo directamente en el editor.
Cuando compartas una página, indica en qué rama estás trabajando para que puedan confirmar que están viendo la versión correcta.