Vue d’ensemble
Pour les dépôts publics
L’expérience complète Ask Devin, incluant la recherche avancée dans le code, la planification et la création de sessions, est disponible dans l’application Devin. DeepWiki public et le DeepWiki MCP offrent des fonctionnalités de base de documentation et de questions-réponses.
Pilotage de DeepWiki

.devin/wiki.json vous permet de piloter le comportement par défaut de génération de wiki de Devin, ce qui est particulièrement important pour les grands dépôts qui peuvent atteindre les limites intégrées.
Si un fichier .devin/wiki.json est trouvé dans le répertoire racine de votre dépôt lors de la génération du wiki, nous utiliserons les repo_notes et pages fournis pour orienter la génération du wiki. Si pages est renseigné, nous contournerons la planification par clusters par défaut et créerons exactement les pages que vous aurez spécifiées. Cela garantit que les parties importantes de votre base de code sont documentées, même lorsque le système automatique les ignorerait autrement.
Format de configuration
.devin/wiki.json à la racine de votre dépôt avec la structure suivante :
Options de configuration
repo_notes (Array)
- content (string, obligatoire) : contenu de la note (max. 10 000 caractères)
- author (string, facultatif) : personne ayant rédigé la note
pages (Array, optionnel)
repo_notes, le système générera tout de même un wiki, en utilisant vos notes pour guider la structure et l’orientation sans que vous ayez à définir chaque page.
Lorsque vous fournissez des pages, elles sont traitées comme des instructions explicites. Seules les pages que vous définissez dans le JSON seront générées, ni plus ni moins.
- title (string, requis) : le titre de la page (doit être unique et non vide)
- purpose (string, requis) : ce que cette page doit documenter
- parent (string, optionnel) : titre de la page parente pour une organisation hiérarchique
- page_notes (array, optionnel) : notes supplémentaires spécifiques à cette page
Limites de validation
- Maximum 30 pages (80 pour la version Entreprise)
- Maximum 100 notes au total (repo_notes + l’ensemble des page_notes combinées)
- Maximum 10 000 caractères par note
- Les titres de page doivent être uniques et non vides
Exemples pratiques
Exemple 1 : repo_notes pour guider la génération du wiki
Exemple 2 : s’assurer que certains dossiers spécifiques sont documentés
Exemple 3 : Gestion des composants manquants
Exemple 4 : Structure hiérarchique de la documentation
Bonnes pratiques
1. Utiliser les Repo Notes de manière stratégique
- Apporter du contexte sur les parties les plus importantes de votre base de code
- Mentionner les dossiers ou composants spécifiques à traiter en priorité
- Expliquer les relations entre les différentes parties de votre système
2. Organiser les pages de manière logique
- Commencez par des pages de présentation générale
- Utilisez des relations parent-enfant pour créer des hiérarchies claires
- Regroupez les fonctionnalités connexes
3. Soyez précis sur l’objectif de chaque page
- Indiquez clairement ce que chaque page doit documenter
- Mentionnez les répertoires, fichiers ou concepts spécifiques à traiter
- Donnez suffisamment de détails pour que le système comprenne votre intention
4. Traiter les lacunes connues
- Si vous savez que certaines parties de votre base de code ne sont pas prises en compte, incluez-les explicitement
- Utilisez des titres descriptifs qui indiquent clairement ce qui doit être couvert
Résolution des problèmes courants
« Seuls certains dossiers sont documentés »
.devin/wiki.json pour spécifier explicitement quelles parties de votre base de code doivent être documentées.
”Des composants importants manquent dans le wiki”
Mise en route
- Créez
.devin/wiki.jsonà la racine de votre dépôt - Ajoutez
repo_notesdécrivant la structure de votre base de code et vos priorités - Si nécessaire, spécifiez toutes les pages que vous souhaitez voir créées, avec des titres et des objectifs clairs
- Validez le fichier (commit) et régénérez votre wiki

