DeepDocs

DeepDocs est un agent IA GitHub qui maintient votre documentation technique parfaitement synchronisée avec votre base de code. Lorsque vous validez des modifications de code, il analyse l’ensemble de votre dépôt pour trouver la documentation nécessitant une mise à jour et effectue automatiquement les changements nécessaires.

Contrairement aux générateurs de documentation traditionnels qui créent des fichiers à partir de zéro, DeepDocs met à jour uniquement les sections qui doivent être modifiées tout en conservant votre style et votre mise en forme d’origine. Il fonctionne avec des outils de documentation populaires comme Docusaurus, Mintlify, MkDocs et Read the Docs.

DeepDocs propose une version gratuite pour les projets personnels avec 10 crédits de scan mensuels, et une version Pro pour les équipes qui publient fréquemment du code, offrant 100 crédits de scan par mois et la prise en charge de jusqu’à cinq fichiers ou dossiers de documentation simultanément.

Commencer avec DeepDocs est simple et prend environ deux minutes. Voici les étapes :

• Installez l'application DeepDocs depuis le GitHub Marketplace sur votre dépôt contenant votre code source et votre documentation. Si votre documentation se trouve dans un dépôt séparé, installez-la également là-bas.

• Créez un fichier de configuration appelé deepdocs.yml à la racine de votre branche principale. Ce fichier indique à DeepDocs quels fichiers ou dossiers de documentation vous souhaitez synchroniser avec votre code.

• Validez le fichier de configuration dans votre dépôt. DeepDocs effectuera immédiatement une analyse complète de votre base de code, détectera toute documentation obsolète et vous enverra un rapport détaillé par email avec des corrections proposées.

• Après la configuration initiale, DeepDocs fonctionne automatiquement à chaque nouveau commit, analysant vos modifications et mettant à jour la documentation pertinente dans des branches séparées pour votre revue avant fusion.

• Mises à jour automatiques de la documentation à chaque commit

• Analyse complète du dépôt à chaque modification de code

• Met à jour uniquement les sections obsolètes tout en préservant la mise en forme

• Rapports détaillés des changements de documentation

• Intégration native GitHub avec le workflow des pull requests

• Fonctionne avec les monorepos et les dépôts de documentation séparés

• Prend en charge Docusaurus, Mintlify, MkDocs, Read the Docs

• Mises à jour intelligentes sans réécritures complètes

• Notifications par email avec les résultats de l’analyse

• Processus d’installation facile en deux minutes