Moxie Docs

Qu’est-ce que Moxie Docs ?

Moxie Docs est un système de documentation pour les dépôts GitHub qui génère et maintient automatiquement la documentation de la base de code. Il indexe un dépôt, crée une documentation recherchable sur l’architecture, les conventions et les guides pas à pas, puis revérifie ces pages lorsque le code change afin que le contenu obsolète puisse être signalé et réécrit.

Il expose aussi les conventions du dépôt et un contexte vérifié aux outils d’IA via MCP, avec un accès en lecture seule limité à la tâche. En plus, il peut ouvrir chaque semaine une pull request “Friday Cleanup” dédiée à la documentation pour regrouper les dérives accumulées au cours de la semaine.

Fonctionnalités clés

• Indexation continue du dépôt : Moxie se connecte à un dépôt GitHub et maintient l’index à jour au fil des merges, afin que la documentation reste liée au code le plus récent.
• Documentation générée et sourcée : Il crée des pages d’architecture, des conventions et des guides pas à pas avec des citations pointant vers le code source, ce qui facilite la vérification du résultat.
• Détection des écarts à la fusion : Lorsque des changements de code affectent une documentation existante, Moxie signale l’écart et régénère les pages concernées au lieu de les laisser obsolètes.
• Contexte MCP pour les agents : Des outils d’IA comme Cursor, Claude Code et Codex peuvent récupérer les conventions, la documentation et des commandes vérifiées via MCP sans réindexer le dépôt à chaque requête.
• Pull requests Friday Cleanup : Une fois par semaine, Moxie peut ouvrir une pull request limitée à la documentation pour rassembler et présenter les mises à jour à relire.
• Vérifications du workflow de PR : Il peut analyser les pull requests pour l’impact sur la documentation et l’alignement de la description avant la fusion, tout en laissant à l’équipe le contrôle des changements de code et de la fusion.

Comment utiliser Moxie Docs

Commencez par connecter un dépôt GitHub. Moxie indexe la base de code, génère le premier ensemble de documentation et résume les conventions réutilisables par des humains ou des agents IA.

Ensuite, les équipes l’utilisent principalement de deux façons : relire la documentation générée et mise à jour par Moxie, et le laisser vérifier les nouvelles pull requests pour détecter une documentation obsolète ou des descriptions incohérentes. Si souhaité, l’intégration MCP peut être utilisée par des agents de développement pour récupérer un contexte propre au dépôt, de manière limitée et en lecture seule.

Cas d’usage

• Garder la documentation d’architecture à jour : une équipe maintient des pages comme le comportement des webhooks ou les flux de facturation, Moxie mettant à jour la documentation lorsque les changements de code correspondants sont intégrés.
• Fournir du contexte de dépôt aux agents de codage : les développeurs utilisant Cursor, Claude Code ou Codex peuvent récupérer les conventions et les commandes vérifiées sans parcourir manuellement le dépôt.
• Relire chaque semaine la dérive de la documentation : les équipes qui veulent un rythme régulier de nettoyage peuvent examiner la pull request Friday Cleanup dédiée à la documentation plutôt que de courir après des pages obsolètes au cas par cas.
• Vérifier l’impact des PR avant la fusion : les mainteneurs peuvent voir si une pull request affecte la documentation ou nécessite une réécriture de la description avant sa fusion.
• Onboarding de nouveaux ingénieurs : les nouveaux contributeurs peuvent rechercher la documentation générée et les signets dans un seul espace de travail au lieu de lire plusieurs fichiers source pour comprendre les conventions.

FAQ

Moxie modifie-t-il mon code automatiquement ?
Non. Le texte source indique que les changements de code restent sous le contrôle de l’équipe. Les mises à jour de documentation sont fournies sous forme de pull requests de documentation révisables, et l’alignement de la description modifie la description de la PR plutôt que le code.

Que se passe-t-il après la connexion d’un dépôt ?
Moxie indexe le dépôt, génère une documentation recherchable, résume les conventions et commence à vérifier les nouvelles pull requests pour l’impact sur la documentation et l’alignement de la description.

L’accès au dépôt est-il limité ?
Oui. La description du produit indique que l’accès est en lecture seule par défaut et limité par dépôt, et que le contexte MCP est restreint à la tâche plutôt qu’à l’ensemble de la base de code.

Quels types de documentation génère-t-il ?
La page mentionne précisément des pages d’architecture, des conventions, des guides pas à pas et de la documentation sur des sujets comme les webhooks de facturation.

Fonctionne-t-il uniquement avec GitHub ?
La page est rédigée pour des dépôts GitHub, donc GitHub est la source prise en charge décrite ici.

Alternatives

• Documentation manuelle en Markdown ou wiki de documentation : C’est l’alternative la plus simple, mais elle ne revérifie pas automatiquement la documentation par rapport au code et ne génère pas de mises à jour sourcées.
• Outils génériques de recherche de code et de navigation dans les dépôts : Ils aident à inspecter les fichiers, mais ne fournissent pas de couche de documentation maintenue ni de PR de nettoyage dédiées à la documentation.
• Assistants de codage IA autonomes sans documentation consciente du dépôt : Ils peuvent répondre aux questions et modifier le code, mais ils dépendent toujours du modèle pour redécouvrir le contexte, sauf s’ils sont associés à un système comme Moxie.
• Flux de travail de documentation internes basés sur les pull requests et la revue : Les équipes peuvent gérer la documentation manuellement via des PR, mais elles doivent créer et suivre elles-mêmes les contrôles de dérive au lieu qu’ils soient générés à partir de la base de code.