Generate Instant Documentation: A Guide to Using DeepWiki for GitHub and GitLab Repos

Tired of manually writing documentation for your GitHub and GitLab projects? DeepWiki automates the process, creating interactive wikis with AI-powered analysis and visual diagrams. Learn how to use DeepWiki to generate beautiful documentation in seconds.

Why Use DeepWiki for Your Code Documentation?

• Save Time: Generate comprehensive documentation instantly, freeing up your time for coding.
• Improve Understanding: Visual diagrams explain code structure and relationships, making your project easier to grasp.
• Enhance Collaboration: Provide collaborators with an easy-to-navigate wiki, improving onboarding and knowledge sharing.

Get Started with DeepWiki: Two Easy Methods

You can quickly get started using either Docker or Manual Setup.

Option 1: Docker (Recommended)

Docker offers a streamlined way to run DeepWiki. Here's how:

1. Clone the Repository:

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

   Copy

2. Create a .env File: Add your API keys for Google and OpenAI.

   echo "GOOGLE_API_KEY=your_google_api_key" > .env
   echo "OPENAI_API_KEY=your_openai_api_key" >> .env
   

   Copy

3. Run with Docker Compose:

   docker-compose up
   

   Copy

Option 2: Manual Setup

For a more hands-on approach, follow these steps:

1. Set Up API Keys: Create .env in your project root and set keys:

   GOOGLE_API_KEY=your_google_api_key
   OPENAI_API_KEY=your_openai_api_key
   

2. Start the Backend:

   pip install -r api/requirements.txt
   python -m api.main
   

   Copy

3. Start the Frontend:

   npm install
   # or
   yarn install
   npm run dev
   # or
   yarn dev
   

   Copy

4. Use DeepWiki! Head to http://localhost:3000 in your browser, enter a GitHub or GitLab repository and click "Generate Wiki"!

Unlocking the Magic: How DeepWiki Analyzes Your Code

DeepWiki leverages AI to create meaningful documentation:

• Clones and Analyzes: Fetches your repository and deeply examines the code.
• Creates Embeddings: Generates code embeddings for smart information retrieval.
• Generates Documentation: Uses AI to produce context-aware, accurate documentation.
• Visual Diagrams: Generates visualizations to show code relationships and architecture.
• Organizes as Wiki: Seamlessly structures everything into an interactive and searchable wiki.

Deciphering DeepWiki: Project Structure Explained

Understanding the project structure helps with customization and troubleshooting:

• api/: Backend API server (Python, FastAPI). Handles data, RAG, etc.
• src/: Frontend Next.js app with React components.
• public/: Static assets.
• package.json: Stores your Javascript dependencies.
• .env: Location for environment variables.

Advanced DeepWiki Setup: Customize Your Experience

Environment Variables

Make sure you have correctly set your API keys in the .env file.

Docker Setup

Alternatively, pull and run the Docker Image directly.

docker pull ghcr.io/asyncfuncai/deepwiki-open:latest

docker run -p 8001:8001 -p 3000:3000 \
  -e GOOGLE_API_KEY=your_google_api_key \
  -e OPENAI_API_KEY=your_openai_api_key \
  -v ~/.adalflow:/root/.adalflow \
  ghcr.io/asyncfuncai/deepwiki-open:latest

Troubleshooting Common DeepWiki Issues

Encountering problems? Here's how to troubleshoot.

• Missing API Keys: Verify .env exists and contains both GOOGLE_API_KEY and OPENAI_API_KEY.
• Invalid API Key: Double-check for extra spaces or incorrect characters when copying.
• Cannot Connect: API server must run on port 8001.
• CORS Errors: Run the frontend and backend on same machine.
• Wiki Generation Errors: Try a smaller repository first.
• Invalid Repo Format: Use valid GitHub or GitLab URL.
• Diagram Errors: The app tries to automatically fix these.

General fixes: Restart your servers, inspect browser/API logs.

Contribute to DeepWiki: Help Improve Documentation for All

Your contributions make DeepWiki better. You can:

• Report bugs or request features via issues.
• Submit code improvements through pull requests.
• Share feedback and ideas to shape the project's future.

License

DeepWiki is MIT licensed, according to the LICENSE file.