← Voltar ao dashboard Conectar GitHub
FAQ + passo a passo para cadastrar repositórios

Arquitetura clara.
Onboarding simples.

Nesta página você aprende como cadastrar seu repositório na Araknet — em uma única sequência: conectar GitHub → token classic temporário → adicionar owner/repo + branch → fila → gerar documentação.

Passo a passo (3–5 minutos)

Tudo o que você precisa para cadastrar um repositório e gerar documentação.

1
Conecte o GitHub

No dashboard, clique em Conectar GitHub e autorize o acesso. Você retorna automaticamente para a Araknet.

2
Gere um token temporário (PAT classic)

Após conectar, a Araknet pedirá um token classic. Gere no GitHub com expiração curta e cole no campo solicitado.

GitHub → Settings → Developer settings → Tokens (classic)
3
Adicione seu repositório no formato owner/repo

Dentro do dashboard, informe o repositório exatamente assim:

organizacao/repositorio
4
Escolha a branch que será analisada

No mesmo momento em que adiciona o repositório, informe a branch (ex.: main). A doc é gerada a partir dela.

main
5
Adicione à fila de geração de documentação

Clique em Adicionar. Quando o status estiver pronto, clique em Gerar documentação.

Dica: comece com 1 repositório menor para validar o resultado e depois escale.
Dúvidas frequentes (FAQ)

Respostas rápidas para os problemas mais comuns.

Onde eu encontro o token “classic”? ⌄
Gere no GitHub em:
  • Settings → Developer settings → Personal access tokens → Tokens (classic)
Use expiração curta (7–30 dias) e permissões compatíveis com seus repositórios.
Quais permissões preciso no token? ⌄
Recomendado:
  • repo (necessário para repositórios privados)
  • read:org (se o repositório estiver em uma organização)
A Araknet lista automaticamente meus repositórios? ⌄
Não. Você adiciona manualmente no formato owner/repo, escolhe a branch e enfileira.
“Repository not found” — o que significa? ⌄
Normalmente é um destes pontos:
  • Formato errado (precisa ser owner/repo)
  • Você não tem acesso ao repositório no GitHub
  • Token sem permissão repo
A branch não existe / dá erro — como resolver? ⌄
Confirme no GitHub o nome exato da branch (ex.: main, master, develop). Atenção: nomes são case-sensitive.
Meu token expirou — preciso conectar de novo? ⌄
Normalmente não. Basta gerar um novo token classic e substituir no campo do dashboard.
Preview do resultado

O tipo de visão que a Araknet gera a partir do seu código.

Architecture Overview
- Modules: auth, billing, docs
- Services: api, worker, web
- Data: postgres, redis, s3
- Integrations: github-app (installation_id)
- Docs Coverage: 74%

Key Flows
1) Auth -> Company -> Repos
2) Repo scan -> Chunk -> Summaries
3) Final docs -> Publish
Troubleshooting rápido

Se algo falhar, comece por aqui.

A
Formato

Confirme owner/repo (sem espaços).

B
Permissões

Token classic com repo e (se org) read:org.

C
Branch

Verifique o nome exato da branch no GitHub.