Transformez Votre Dépôt GitHub/GitLab en Wiki Interactif grâce à DeepWiki-Open

Fatigué de la documentation statique et obsolète ? Découvrez comment DeepWiki-Open transforme n'importe quel dépôt GitHub ou GitLab en un wiki interactif et facile à utiliser. Plus besoin de passer des heures à rédiger de la documentation, l'IA le fait pour vous !

Créez Instantanément une Documentation Complète et Accessible

DeepWiki-Open simplifie la création de documentation technique. En quelques secondes, obtenez :

• Documentation Automatique: Générez un wiki complet pour votre projet en un clin d'œil.
• Analyse Intelligente: L'IA comprend la structure de votre code et ses interconnexions.
• Diagrammes Visuels: Des diagrammes Mermaid automatiques illustrent l'architecture et le flux de données. Ainsi vos collaborateurs visualisent le code simplement et rapidement.
• Navigation Intuitive: Une interface simple pour explorer le wiki sans difficulté.

Démarrage Rapide : Deux Options Simples pour Débuter

Découvrez comment installer DeepWiki-Open en quelques étapes simples :

Option 1 : Installation via Docker (Recommandée)

1. Clonez le dépôt :

   git clone https://github.com/AsyncFuncAI/deepwiki-open.git
   cd deepwiki-open
   

   Copy

2. Créez un fichier .env avec vos clés API :

   echo "GOOGLE_API_KEY=votre_cle_google" > .env
   echo "OPENAI_API_KEY=votre_cle_openai" >> .env
   

   Copy

3. Lancez avec Docker Compose :

   docker-compose up
   

   Copy

Option 2 : Installation Manuelle

1. Configurez vos clés API: Créez un fichier .env à la racine du projet et ajoutez vos clés :

   GOOGLE_API_KEY=votre_cle_google
   OPENAI_API_KEY=votre_cle_openai
   

2. Démarrez le Backend:

   • Installez les dépendances Python : pip install -r api/requirements.txt
   • Lancez le serveur API : python -m api.main

3. Démarrez le Frontend:

   • Installez les dépendances JavaScript : npm install ou yarn install
   • Lancez l'application web : npm run dev ou yarn dev

4. Utilisez DeepWiki ! Ouvrez http://localhost:3000 dans votre navigateur. Saisissez l'URL d'un dépôt GitHub ou GitLab (comme facebook/react, vercel/next.js ou https://gitlab.com/gitlab-org/gitlab) et cliquez sur "Generate Wiki".

Comment DeepWiki Transforme Votre Code en Documentation Interactif

DeepWiki utilise l'IA pour simplifier le processus de documentation :

1. Clone le dépôt GitHub/GitLab et analyse sa structure.
2. Crée des embeddings du code pour faciliter la recherche intelligente.
3. Génère une documentation contextuelle à l'aide de l'IA.
4. Crée des diagrammes visuels pour illustrer les relations entre les éléments du code.
5. Organise le tout dans un wiki structuré et facile à explorer.

Résolvez les Problèmes Courants en Un Clin d'oeil

Naviguez facilement dans la résolution si vous rencontrez des difficultés :

• Problèmes de Clé API: Assurez-vous que votre fichier .env est correctement configuré et que les clés sont valides.
• Problèmes de Connexion: Vérifiez que le serveur API est en cours d'exécution et que la configuration CORS est correcte.
• Problèmes de Génération: Essayez avec un dépôt plus petit ou vérifiez le format de l'URL.

Contribuez à l'Amélioration de DeepWiki-Open

Votre contribution est la bienvenue ! N'hésitez pas à :

• Signaler les bugs et proposer de nouvelles fonctionnalités.
• Soumettre des pull requests pour améliorer le code.
• Partager vos commentaires et idées.

Licence Libre et Ouverte pour une Utilisation Sans Limite

Ce projet est sous licence MIT, vous offrant une grande liberté d'utilisation et de modification. Consultez le fichier LICENSE pour plus de détails.

Avec DeepWiki-Open, simplifiez la documentation de vos projets et gagnez un temps précieux.