Cómo usar el editor
Recorrido paso a paso por el editor de Mintlify: cree una branch, edite páginas, comparta un despliegue de vista previa para su revisión y publique sus cambios.
Este tutorial le guía a través de una actualización completa de contenido usando el editor. Creará una branch, hará un cambio, compartirá una vista previa para su revisión y publicará sus cambios.
Crear una branch
Una branch es una copia temporal de su contenido. Es donde realiza sus cambios sin afectar a su sitio publicado. Puede hacer merge de una branch en su sitio publicado o descartarla de forma segura si decide no aplicar los cambios.
Trabajar en una branch mantiene sus ediciones separadas de su sitio publicado hasta que esté listo para compartir el contenido con sus usuarios.
- En la barra de herramientas del editor, haga clic en el nombre de la branch (normalmente
main, con una insignia Live). Si no lo ve, muestre el selector de branch. - En Find a branch, escriba un título que describa su cambio, como
Update quickstart. - Haga clic en New branch.
El editor cambia a su nueva branch. Cualquier cambio que realice está solo en la branch, y se hace commit en la branch automáticamente mientras trabaja. Solo aparecerán en su sitio publicado si completa el proceso de publicación.
Realizar los cambios
Edite una página existente o cree una nueva.
Para editar una página: Haga clic en el nombre de la página en la barra lateral de navegación para abrirla. Escriba directamente en el editor para añadir contenido. Presione / para insertar componentes, imágenes u otro contenido.
Para crear una página: Haga clic en el botón más junto al grupo de navegación donde quiere añadir la página y luego haga clic en New page. Escriba un título para la página. El editor nombra el archivo con el título.
Publicar su branch
Cuando edita una branch por primera vez, el editor le abre una pull request. Una pull request es una propuesta para hacer merge de sus cambios en la branch que compila su sitio publicado. Sus cambios solo se publican después de que la pull request se haya fusionado.
Cuando esté listo para la revisión, solicítela desde el menú de publicación.
- Haga clic en Publish en la barra de herramientas para abrir el menú de publicación.
- Opcionalmente, haga clic en cualquier archivo modificado de la lista para ver y comparar sus ediciones con la versión publicada.
- Haga clic en Request review.
Se compila un despliegue de vista previa para su pull request: un enlace temporal donde sus cambios se representan exactamente como se verían en su sitio publicado. Encuentre la URL en el comentario de la pull request del bot de Mintlify y compártala con sus revisores.
Obtener la aprobación de su pull request
Comparta la pull request con su equipo. Para abrirla, haga clic en View request en el menú de publicación. Los revisores pueden abrir la pull request en GitHub, GitLab o Bitbucket para dejar comentarios, solicitar cambios o aprobarla.
Si un revisor solicita cambios, realice las ediciones en el editor en la misma branch. Sus actualizaciones se hacen commit en la pull request existente automáticamente. No necesita crear una nueva.
Cuando todos los revisores requeridos hayan aprobado, la pull request está lista para hacer merge.
Hacer merge y publicar
Con la pull request aprobada, haga clic en Publish en la barra de herramientas para reabrir el menú de publicación. El menú ahora muestra el estado de la pull request y una opción para hacer merge.
Haga clic en Merge and publish. Si Mintlify aloja su repositorio y no se requieren aprobaciones, el botón se llama Publish. El editor hace merge de la pull request y le devuelve a su deployment branch. Mintlify compila y despliega sus cambios. Su sitio publicado se actualiza en unos 30 segundos a unos pocos minutos.