Panoramica
Per i repository pubblici
L’esperienza completa di Ask Devin, inclusa la ricerca avanzata nel codice, la pianificazione e la creazione di sessioni, è disponibile nell’app Devin. La versione pubblica di DeepWiki e il DeepWiki MCP forniscono funzionalità di documentazione e di domande e risposte di base.
Gestire DeepWiki

.devin/wiki.json ti consente di controllare il comportamento predefinito di generazione della wiki di Devin, il che è particolarmente importante per i repository di grandi dimensioni che potrebbero raggiungere i limiti predefiniti.
Se durante la generazione della wiki viene trovato un file .devin/wiki.json nella directory radice del tuo repository, utilizzeremo i repo_notes e pages forniti per orientare la generazione della wiki. Se pages è presente, salteremo la pianificazione predefinita basata sui cluster e creeremo esattamente le pagine che specifichi. Questo garantisce che le parti importanti della tua base di codice vengano documentate anche quando il sistema automatico altrimenti le ignorerebbe.
Formato di configurazione
.devin/wiki.json nella directory principale del repository con la seguente struttura:
Opzioni di configurazione
repo_notes (Array)
- content (string, required): il contenuto della nota (fino a 10.000 caratteri)
- author (string, optional): chi ha scritto la nota
pages (Array, facoltativo)
- title (string, obbligatorio): Il titolo della pagina (deve essere univoco e non vuoto)
- purpose (string, obbligatorio): Cosa deve documentare questa pagina
- parent (string, facoltativo): Titolo della pagina padre per l’organizzazione gerarchica
- page_notes (array, facoltativo): Note aggiuntive specifiche per questa pagina
Limiti di convalida
- Massimo 30 pagine (80 per i clienti enterprise)
- Massimo 100 note complessive (repo_notes + tutte le page_notes combinate)
- Massimo 10.000 caratteri per nota
- I titoli delle pagine devono essere univoci e non vuoti
Esempi pratici
Esempio 1: Repo Notes per guidare la generazione della wiki
Esempio 2: Assicurarsi che cartelle specifiche siano documentate
Esempio 3: Gestione dei componenti mancanti
Esempio 4: Struttura gerarchica della documentazione
Best practice consigliate
1. Usa le Repo Notes in modo strategico
- Fornisci contesto su quali parti della tua codebase sono più importanti
- Indica cartelle o componenti specifici a cui dare priorità
- Spiega le relazioni tra le diverse parti del tuo sistema
2. Organizza le pagine in modo logico
- Inizia con pagine di panoramica ad alto livello
- Usa relazioni padre-figlio per creare gerarchie chiare
- Raggruppa le funzionalità correlate
3. Sii specifico negli obiettivi di ogni pagina
- Indica chiaramente cosa dovrebbe documentare ciascuna pagina
- Specifica le directory, i file o i concetti su cui concentrarsi
- Fornisci dettagli sufficienti affinché il sistema comprenda le tue intenzioni
4. Colma le lacune note
- Se sai che alcune parti della tua codebase vengono escluse, includile esplicitamente
- Usa titoli descrittivi che rendano chiaro cosa deve essere trattato
Risoluzione dei problemi più comuni
”Solo alcune cartelle vengono documentate”
.devin/wiki.json per specificare in modo esplicito quali parti della tua codebase devono essere documentate.
”Mancano componenti importanti nella wiki”
Per iniziare
- Crea
.devin/wiki.jsonnella directory principale del tuo repository - Aggiungi
repo_notesche spieghino la struttura della tua codebase e le priorità - Se necessario, specifica tutte le pagine che vuoi vengano create, con titoli e obiettivi chiari
- Esegui il commit del file e rigenera la tua wiki

