Skip to main content

Vue d’ensemble

Devin indexe désormais automatiquement vos dépôts et produit des wikis avec des diagrammes d’architecture, des liens vers les sources et des résumés de votre base de code. Utilisez-le pour vous familiariser rapidement avec les parties de votre base de code que vous connaissez moins bien — consultez-le dans votre barre latérale. Ask Devin utilisera les informations du Wiki pour mieux comprendre et trouver le contexte pertinent dans votre base de code. Les capacités de recherche avancée dans le code d’Ask Devin, combinées à DeepWiki, produisent des réponses détaillées et précises, fondées sur votre code.
DeepWiki sera généré automatiquement lors de la connexion des dépôts pendant l’onboarding.

Pour les dépôts publics

Une version gratuite de DeepWiki et d’Ask Devin, compatible avec les dépôts GitHub publics, est désormais disponible. Elle génère automatiquement des diagrammes d’architecture, de la documentation et des liens vers le code source pour vous aider à comprendre rapidement des bases de code qui vous sont encore inconnues. Vous pouvez également poser des questions complexes sur la base de code pour obtenir des réponses spécifiques, fondées sur le contexte.
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.
Visitez deepwiki.com pour commencer à explorer des dépôts open source populaires comme React, TensorFlow, LangChain et bien d’autres. Vous pouvez également soumettre l’URL de votre propre dépôt GitHub public pour l’indexation. Essayez DeepWiki dès maintenant →

Niveaux d’effort et coût

La génération du wiki s’effectue selon l’un des trois niveaux d’effort, configurables par org (et remplaçables au niveau du repo) depuis la page du wiki :
Les wikis à niveau d’effort moyen ou élevé sont facturés sur l’utilisation des ACU de votre Team. Ils nécessitent donc un abonnement actif ou un solde de crédits positif. Si votre Team ne dispose d’aucun des deux, la génération est refusée et aucun wiki n’est produit : ajoutez des crédits ou passez au niveau d’effort faible.
Les orgs Enterprise s’exécutent toujours avec un niveau d’effort faible ; ce paramètre ne peut pas être configuré pour elles.

Pilotage de DeepWiki

Steerable Wiki UI
Le fichier .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. Les deux champs sont obligatoires, et pages doit lister au moins une page. Lorsqu’un fichier de configuration est présent, nous contournons la planification par clusters par défaut et créons exactement les pages que vous spécifiez — listez donc toutes les pages souhaité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

Créez un fichier .devin/wiki.json à la racine de votre dépôt avec la structure suivante :

Options de configuration

repo_notes (Array, obligatoire)

Fournit du contexte et des instructions pour aider le système de documentation à mieux comprendre votre dépôt. Incluez la clé repo_notes même si vous n’avez aucune note à ajouter — utilisez un tableau vide ([]).
  • content (string, obligatoire) : contenu de la note (max. 10 000 caractères)
  • author (string, facultatif) : personne ayant rédigé la note

pages (Tableau, requis)

Spécifie exactement quelles pages doivent être créées dans votre wiki. Ce champ est requis et doit contenir au moins une page. Les pages 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. Un fichier .devin/wiki.json qui omet pages (ou le laisse vide) est rejeté, veillez donc à lister chaque page que vous souhaitez créer.
  • 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 (tableau, 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 : utiliser les repo notes pour mettre en avant les priorités

Utilisez repo_notes pour indiquer à Devin ce qu’il doit mettre en avant, et listez à côté les pages que vous souhaitez. Les notes déterminent la façon dont chaque page est rédigée ; pages détermine quelles pages sont créées.

Exemple 2 : s’assurer que certains dossiers spécifiques sont documentés

Si votre vaste dépôt contient des dossiers importants qui ne sont pas inclus dans le wiki, ajoutez une page pour chacun d’eux et utilisez repo_notes pour expliquer pourquoi ils sont importants :

Exemple 3 : Gestion des composants manquants

Si vous constatez que certaines parties de votre base de code ne sont pas documentées, ajoutez une page pour chacune d’elles et mettez-les en avant dans repo_notes :

Exemple 4 : Structure hiérarchique de la documentation

Pour les dépôts complexes, organisez les pages de manière hiérarchique :

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 »

C’est le problème classique des gros dépôts. Solution : Utilisez .devin/wiki.json pour spécifier explicitement quelles parties de votre base de code doivent être documentées.
Ajoutez une page au tableau pages pour chaque dossier que vous souhaitez couvrir, et utilisez repo_notes pour expliquer leur importance. Le wiki ne génère que les pages que vous listez : tout dossier sans page n’apparaîtra donc pas.

”Des composants importants manquent dans le wiki”

Ajoutez des pages spécifiques pour ces composants et utilisez repo_notes pour mettre en avant leur importance.
Rappel : DeepWiki générera uniquement les pages incluses dans ce tableau, donc assurez-vous que toutes les pages sont présentes, et pas seulement la page manquante.

Mise en route

  1. Créez .devin/wiki.json à la racine de votre dépôt
  2. Ajoutez repo_notes décrivant la structure de votre base de code et vos priorités
  3. Spécifiez toutes les pages que vous souhaitez voir créées, avec des titres et des objectifs clairs (au moins une page est requise)
  4. Validez le fichier (commit) et régénérez votre wiki
Le système créera désormais la documentation sur la base de vos instructions explicites plutôt que sur une analyse entièrement automatique, ce qui permet d’assurer une couverture plus complète et plus précise des grands dépôts.