GitHub

Sincroniza tu documentación con un repositorio de GitHub

Mintlify utiliza una Aplicación de GitHub para sincronizar automáticamente tu documentación con tu repositorio de GitHub.

​

Instalar la Aplicación de GitHub

Instala la Aplicación de GitHub de Mintlify en la cuenta u organización de GitHub que sea propietaria de tu repositorio de documentación. Debes ser propietario de la organización o tener permisos de administrador en el repositorio para instalar la aplicación. Si no cuentas con los permisos necesarios, el propietario del repositorio deberá aprobar la solicitud de instalación.

Instala la Aplicación de GitHub de Mintlify desde tu dashboard.

Recomendamos otorgar acceso solo al repositorio donde se aloja tu documentación.

​

Permisos

Cuando instales la Aplicación de GitHub, se te pedirá que concedas los siguientes permisos:

Permisos de lectura:

• metadata: Información básica del repositorio

Permisos de lectura y escritura:

• checks: Crear verificaciones de estado en solicitudes de extracción
• code: Leer cambios de archivos cuando confirmes en tu branch de documentación
• deployments: Generar implementaciones de vista previa para solicitudes de extracción
• pull requests: Crear branches y solicitudes de extracción desde el editor web
• workflows: Administrar GitHub Actions para implementaciones de la documentación

La aplicación solo accede a los repositorios a los que le otorgues acceso explícitamente. Si tienes habilitadas reglas de protección de branch, la aplicación no puede hacer push directamente a branches protegidas.

​

Gestión del acceso a repositorios

Al instalar nuestra Aplicación de GitHub, puedes otorgar acceso a todos tus repositorios o solo a algunos específicos. Recomendamos otorgar acceso únicamente a los repositorios donde se aloja tu documentación. Puedes modificar esta selección en cualquier momento en la configuración de la aplicación de GitHub.

​

Configurar el source de la documentación

Cambia la organización, el repositorio o la branch desde la que se genera tu documentación en la sección Git Settings de tu dashboard.

​

Resolución de problemas

​

Problemas de conexión con la Aplicación de GitHub

Si tienes problemas con la Aplicación de GitHub, restablecer la conexión puede resolver la mayoría de los casos.

1. Desinstala la aplicación de Mintlify desde GitHub.

   1. En GitHub, ve a installations y selecciona Configure junto a la aplicación de Mintlify. Desplázate hacia abajo y selecciona Uninstall.
   2. Ve a Authorized GitHub Apps y selecciona Revoke junto a la aplicación de Mintlify.
2. Vuelve a instalar la aplicación de Mintlify.

   1. En tu Dashboard de Mintlify, ve a Git Settings e instala la Aplicación de GitHub.
   2. Autoriza tu cuenta en la sección My Profile de tu dashboard.

​

Los add-ons de comentarios no están disponibles

Si no puedes habilitar las opciones de sugerencias de edición o crear issues en tu dashboard y tu repositorio es público, vuelve a validar tu configuración de Git.

1. Ve a Git Settings

   Ve a Git Settings en tu dashboard.

2. Vuelve a validar tu configuración

   Haz clic en la marca de verificación verde en la esquina del recuadro de Git Settings para volver a validar la configuración de tu repositorio. Esto forzará la actualización para reflejar si tu repositorio es público o privado.