AIDotNet/OpenDeepWiki

OpenDeepWiki is the open-source version of the DeepWiki project, aiming to provide a powerful knowledge management and collaboration platform. The project is mainly developed using C# and TypeScript, supporting modular design, and is easy to expand and customize.

What it solves

OpenDeepWiki 會將原始 Git 倉庫、ZIP 壓縮檔或本機目錄轉換為結構化、可搜尋的知識庫。它消除手動為複雜程式碼庫撰寫文件的需求,能自動從原始碼產生專案概覽、維基目錄與詳細文件內容。

How it works

系統會擷取倉庫來源並建立工作區,以分析檔案樹與上下文。接著使用 LLM 產生 README 摘要、維基目錄與文件內容。這些處理過的知識會透過多種管道提供服務:

  • Public Docs Site:一個 SEO 友善的 Next.js 網站,用於瀏覽文件。
  • Chat Assistant:內建聊天介面與嵌入式 API,供查詢倉庫知識。
  • MCP Endpoints:Model Context Protocol (MCP) 端點,讓 AI 代理存取倉庫範圍的知識。
  • Visualizations:產生 Mermaid 心智圖與 Graphify 產物,以視覺化專案結構。

Who it’s for

  • Developers:想自動產生並託管開源或內部專案文件的開發者。
  • AI Agent users:需要為 AI 助手提供特定程式碼庫深度、結構化上下文的使用者。
  • Project Managers:希望透過心智圖與摘要快速了解高階專案結構的專案經理。

Highlights

  • Multi-source ingestion:支援 Git URL、ZIP 檔與本機目錄。
  • AI-driven documentation:自動產生摘要、目錄與多語言翻譯。
  • AI Agent integration:提供 MCP 端點以檢索倉庫範圍的知識。
  • Enterprise-ready:包含管理員控制台以管理使用者、角色與 AI 供應商,並支援 PostgreSQL 以因應生產規模。
  • Omnichannel chat:整合 Feishu、QQ、WeChat 與 Slack。