Skip to main content

Visão geral

Devin agora indexa automaticamente seus repositórios e produz wikis com diagramas de arquitetura, links para as fontes e resumos da sua base de código. Use-o para se atualizar rapidamente sobre partes da sua base de código com as quais você não está familiarizado — confira na sua barra lateral. Ask Devin usará informações da Wiki para entender melhor e encontrar o contexto relevante na sua base de código. Os recursos avançados de pesquisa de código do Ask Devin, combinados com o DeepWiki, produzem respostas detalhadas e precisas baseadas no seu código.
O DeepWiki será gerado automaticamente ao conectar repositórios durante o onboarding.

Para repositórios públicos

Uma versão gratuita do DeepWiki e do Ask Devin que funciona com repositórios públicos do GitHub está disponível. Ela gera automaticamente diagramas de arquitetura, documentação e links para o código-fonte para ajudar você a entender rapidamente bases de código desconhecidas. Você também pode fazer perguntas complexas sobre a base de código para obter respostas específicas baseadas no contexto.
A experiência completa do Ask Devin, incluindo pesquisa avançada de código, planejamento e criação de sessões, está disponível no aplicativo Devin. O DeepWiki público e o DeepWiki MCP fornecem recursos básicos de documentação e perguntas e respostas.
Visite deepwiki.com para começar a explorar repositórios de código aberto populares como React, TensorFlow, LangChain e muitos outros. Você também pode enviar a URL do seu próprio repositório público do GitHub para indexação. Experimente o DeepWiki agora →

Níveis de esforço e custo

A geração da wiki é realizada em um de três níveis de esforço, configuráveis por org (e substituíveis por repo) na página da wiki:
Wikis com esforço médio e alto são cobradas do uso de ACU da sua equipe e, por isso, exigem uma assinatura ativa ou saldo positivo de créditos. Se sua equipe não tiver nenhum dos dois, a geração será recusada e nenhuma wiki será produzida — adicione créditos ou mude o nível de esforço para baixo.
As orgs Enterprise sempre usam o nível de esforço baixo; essa configuração não pode ser alterada para elas.

Orientando o DeepWiki

Steerable Wiki UI
O arquivo .devin/wiki.json permite orientar o comportamento padrão de geração de wiki do Devin, o que é especialmente importante para repositórios grandes que podem atingir limites embutidos. Se um arquivo .devin/wiki.json for encontrado no diretório raiz do seu repositório durante a geração da wiki, usaremos os repo_notes e pages fornecidos para orientar a geração da wiki. Ambos os campos são obrigatórios, e pages deve listar pelo menos uma página. Quando há um arquivo de configuração presente, ignoramos o planejamento padrão baseado em clusters e criamos exatamente as páginas que você especificar — portanto, liste todas as páginas que você quiser. Isso garante que as partes importantes da sua base de código sejam documentadas mesmo quando o sistema automático normalmente as ignoraria.

Formato de configuração

Crie um arquivo .devin/wiki.json na raiz do repositório com a seguinte estrutura:

Opções de configuração

repo_notes (Array, obrigatório)

Fornece contexto e orientação para ajudar o sistema de documentação a compreender melhor o seu repositório. Inclua a chave repo_notes mesmo que não tenha notas a adicionar — use um array vazio ([]).
  • content (string, obrigatório): Conteúdo da nota (máximo de 10.000 caracteres)
  • author (string, opcional): Autor da nota

pages (Array, obrigatório)

Especifica exatamente quais páginas devem ser criadas na sua wiki. Este campo é obrigatório e deve conter pelo menos uma página. As páginas são tratadas como instruções explícitas: somente as páginas definidas no JSON serão geradas — nem mais, nem menos. Um .devin/wiki.json que omite pages (ou o deixa vazio) é rejeitado, então liste todas as páginas que você deseja criar.
  • title (string, obrigatório): O título da página (deve ser único e não vazio)
  • purpose (string, obrigatório): O que esta página deve documentar
  • parent (string, opcional): Título da página principal para organização hierárquica
  • page_notes (array, opcional): Anotações adicionais específicas desta página

Limites de validação

  • No máximo 30 páginas (80 para Enterprise)
  • No máximo 100 notas no total (repo_notes + todas as page_notes combinadas)
  • No máximo 10.000 caracteres por nota
  • Os títulos de página devem ser únicos e não podem estar em branco

Exemplos práticos

Exemplo 1: Use Repo Notes para enfatizar prioridades

Use repo_notes para indicar ao Devin o que enfatizar e liste as pages que você deseja junto com elas. As notas orientam como cada página é escrita; pages determina quais páginas são criadas.

Exemplo 2: Garantindo a documentação de pastas específicas

Se o seu repositório grande tiver pastas importantes que não estão sendo incluídas na wiki, adicione uma página para cada uma delas e use repo_notes para explicar por que elas são importantes:

Exemplo 3: Abordando Componentes Ausentes

Se você notar que certas partes da sua base de código não estão sendo documentadas, adicione uma página para cada uma e destaque-as em repo_notes:

Exemplo 4: Estrutura de Documentação Hierárquica

Para repositórios complexos, organize as páginas de forma hierárquica:

Boas práticas

1. Use Repo Notes de forma estratégica

  • Forneça contexto sobre quais partes do seu codebase são mais importantes
  • Mencione diretórios ou componentes específicos que devem ser priorizados
  • Explique as relações entre diferentes partes do seu sistema

2. Organize as páginas de forma lógica

  • Comece com páginas de visão geral de alto nível
  • Use relações pai-filho para criar hierarquias claras
  • Agrupe funcionalidades relacionadas

3. Seja específico sobre o objetivo de cada página

  • Declare claramente o que cada página deve documentar
  • Mencione diretórios, arquivos ou conceitos específicos em que a página deve focar
  • Forneça detalhes suficientes para o sistema entender sua intenção

4. Aborde Lacunas Conhecidas

  • Se você sabe que certas partes da sua base de código estão ficando de fora, inclua-as explicitamente
  • Use títulos descritivos que deixem claro o que deve ser abrangido

Solução de problemas comuns

”Apenas algumas pastas estão sendo documentadas”

Este é o clássico problema de repositório grande. Solução: Use .devin/wiki.json para especificar explicitamente quais partes da sua base de código devem ser documentadas.
Adicione uma página ao array pages para cada pasta que você quer cobrir e use repo_notes para explicar por que elas são importantes. A wiki gera apenas as páginas que você listar, então qualquer pasta sem uma página não aparecerá.

”Componentes importantes estão ausentes na wiki”

Adicione páginas específicas para esses componentes e use repo_notes para destacar sua importância.
Lembre-se: o DeepWiki irá gerar somente as páginas incluídas nesse array, portanto, certifique-se de que todas as páginas estejam presentes, não apenas a página ausente.

Primeiros passos

  1. Crie .devin/wiki.json na raiz do seu repositório
  2. Adicione repo_notes explicando a estrutura da sua base de código e suas prioridades
  3. Especifique todas as páginas que você quer criar, com títulos e objetivos claros (pelo menos uma página é obrigatória)
  4. Faça o commit do arquivo e regenere sua wiki
O sistema agora criará documentação com base nas suas instruções explícitas, em vez de depender de análise totalmente automática, garantindo uma cobertura mais abrangente e precisa de repositórios grandes.