El editor admite dos flujos de trabajo para publicar actualizaciones de la documentación. El flujo que uses depende de las reglas de protección de branch de tu repositorio y de la branch en la que trabajes.
Crear solicitudes de extracción: Si tu repositorio tiene una regla de protección de branch que requiere solicitudes de extracción antes de que los cambios se puedan fusionar en tu rama de implementación, el editor crea una solicitud de extracción cuando publicas cambios.
Cuando creas una solicitud de extracción desde el editor, el agente de Mintlify genera un título y una descripción en función de tus cambios. Puedes editar el título y la descripción generados antes de crear la solicitud de extracción.
Publicar directamente: Si tu repositorio no tiene reglas de protección de branch, tus cambios se fusionan en la rama de implementación y se implementan de inmediato cuando publicas.
A medida que editas, el editor realiza un seguimiento de tus cambios.
- Archivos nuevos o eliminados.
- Ediciones de contenido en las páginas.
- Cambios en la estructura de navegación.
- Cargas y organización de archivos multimedia.
- Actualizaciones de configuración.
Cuando trabajas en tu rama de implementación, los cambios se guardan automáticamente.
Cuando trabajas en una rama de funcionalidad, guarda los cambios en la rama.
Para descartar cambios, haz clic en Undo changes junto al nombre de un archivo en el menú desplegable de archivos modificados.
Revisar los cambios de una branch
Cuando trabajas en una branch de funcionalidad, el panel de publicación muestra todos los cambios de archivos entre tu branch y la rama de implementación en Saved in branch. Esto incluye los cambios guardados por ti y los de cualquier compañero que trabaje en la misma branch.
Haz clic en un archivo de la lista para abrir una vista de diferencias que muestra los cambios entre la branch y el contenido publicado. Los archivos de documentación se abren en un diff visual, y otros tipos de archivos se abren en un diff de código fuente. Usa esto para revisar el alcance completo de los cambios en una branch antes de publicar.
Los archivos que no pueden mostrar un diff, como imágenes o archivos eliminados, aparecen en la lista pero no son seleccionables.
Haz clic en Publish en la barra de herramientas. Según tu flujo de trabajo, tus cambios se implementan de inmediato o se crea una solicitud de extracción para que la fusiones en tu proveedor de Git. Si estás en una branch de funcionalidad, guarda tus cambios antes de publicar.
Si no hay cambios pendientes o ya hay una solicitud de extracción abierta para la branch actual, no se puede hacer clic en el botón Publish.
Tu sitio de documentación en producción se actualiza después de que Mintlify compila e implementa tus cambios publicados. Esto suele tardar entre 30 segundos y unos pocos minutos. Consulta el estado de implementación de tus cambios en tu dashboard.
Resolver conflictos
Los conflictos se producen cuando tu branch y la rama de implementación contienen cambios incompatibles en los mismos archivos.
Qué provoca los conflictos
Los conflictos se producen cuando intentas fusionar branches con cambios incompatibles en los mismos archivos.
- Tú y otra persona del equipo modifican las mismas líneas de un archivo en distintas branches.
- Los archivos se mueven, renombran o eliminan en una branch, pero se modifican de otra forma en otra.
El editor muestra advertencias cuando los conflictos impiden realizar operaciones como publicar o cambiar de branch. Para resolverlos, sigue las instrucciones del editor para elegir qué cambios conservar.
Firma tus confirmaciones con tu cuenta de GitHub al autorizarla en la configuración de la cuenta. Sin autorización, la Aplicación de GitHub de Mintlify firma las confirmaciones realizadas en el editor web.
Asociar las confirmaciones a tu cuenta mantiene un historial preciso de quién hizo cambios en tu documentación.