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

​
Instalación de la app de GitHub

Instala la app de GitHub de Mintlify en la cuenta u organización de GitHub propietaria de tu repositorio de documentación. Debes ser propietario de la organización o tener permisos de administrador en el repositorio para poder instalar la app. Si no tienes los permisos necesarios, el propietario del repositorio debe aprobar la solicitud de instalación. Instala la app de GitHub de Mintlify desde tu panel.
Recomendamos conceder acceso solo al repositorio donde se aloja tu documentación.
Página de instalación de la app de GitHub de Mintlify con la opción «Only select repositories» seleccionada.

​
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 comprobaciones de estado en las pull requests
  • code: Leer cambios de archivos cuando haces commit en tu rama de documentación
  • deployments: Generar despliegues de vista previa para las pull requests
  • pull requests: Crear ramas y pull requests desde el Editor web
  • workflows: Administrar GitHub Actions para los despliegues de la documentación
La aplicación solo accede a los repositorios a los que le otorgues acceso explícitamente. Si tienes reglas de protección de ramas habilitadas, la aplicación no puede hacer push directamente a las ramas 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. Te recomendamos otorgar acceso únicamente a los repositorios donde se encuentra tu documentación. Puedes modificar esta selección en cualquier momento en la configuración de la aplicación de GitHub.

​
Configurar la fuente de la documentación

Cambia la organización, el repositorio o la rama desde la que se construye tu documentación en la sección Git Settings de tu panel.

​
Solución de problemas

Si tienes problemas con la app de GitHub, restablecer la conexión suele resolver la mayoría de los casos.
1

Desinstala la app de Mintlify desde GitHub.

  1. En GitHub, ve a Installations y selecciona Configure junto a la app de Mintlify. Desplázate hacia abajo y selecciona Uninstall.
  2. Ve a Authorized GitHub Apps y selecciona Revoke junto a la app de Mintlify.
2

Vuelve a instalar la app de Mintlify.

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