A Mintlify usa um aplicativo do GitHub para sincronizar automaticamente sua documentação com o seu repositório no GitHub.

​
Instalando o app do GitHub

Instale o aplicativo Mintlify para GitHub na conta ou organização que é proprietária do repositório das suas documentações. Você precisa ter propriedade da organização ou permissões de administrador no repositório para instalar o app. Se não tiver as permissões necessárias, o proprietário do repositório deverá aprovar a solicitação de instalação. Faça a instalação do aplicativo Mintlify para GitHub pelo seu dashboard.
Recomendamos conceder acesso apenas ao repositório onde sua documentação está hospedada.
Página de instalação do aplicativo Mintlify para GitHub com a opção 'Only select repositories' selecionada.

​
Permissões

Ao instalar o aplicativo do GitHub, você será solicitado a conceder as seguintes permissões: Permissões de leitura:
  • metadata: Informações básicas do repositório
Permissões de leitura e escrita:
  • checks: Criar verificações de status em pull requests
  • code: Ler alterações de arquivos quando você fizer commit no branch de docs
  • deployments: Gerar implantações de pré-visualização para pull requests
  • pull requests: Criar branches e pull requests a partir do Editor web
  • workflows: Gerenciar GitHub Actions para as implantações da documentação
O aplicativo só acessa repositórios aos quais você concede acesso explicitamente. Se você tiver regras de proteção de branch ativadas, o aplicativo não poderá fazer push diretamente para branches protegidos.

​
Gerenciando o acesso aos repositórios

Ao instalar nosso app do GitHub, você pode conceder acesso a todos os seus repositórios ou apenas a repositórios específicos. Recomendamos conceder acesso somente aos repositórios onde sua documentação está. Você pode alterar essa seleção a qualquer momento nas suas configurações do app do GitHub.

​
Configurando a origem da documentação

Altere a organização, o repositório ou a branch de onde sua documentação é gerada na seção Git Settings do seu painel.

​
Solução de problemas

Se você tiver problemas com o app do GitHub, redefinir a conexão pode resolver a maioria deles.
1

Desinstale o app da Mintlify pelo GitHub.

  1. No GitHub, acesse installations e selecione Configure ao lado do app da Mintlify. Role para baixo e selecione Uninstall.
  2. Acesse Authorized GitHub Apps e selecione Revoke ao lado do app da Mintlify.
2

Reinstale o app da Mintlify.

  1. No seu painel da Mintlify, vá até Git Settings e instale o app do GitHub.
  2. Autorize sua conta na seção My Profile do seu painel.