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.

解決する課題

プロジェクトドキュメントを最新に保つことは面倒で、コードと同期しなくなることがよくあります。OpenDeepWiki は、リポジトリ(Git、ZIP、またはローカルフォルダから)を取り込み、AI を使用して構造化された wiki コンテンツ(README、概要、カタログ、詳細ドキュメント、マインドマップなど)を生成することで、これを自動化します。その後、Web サイト、チャットアシスタント、MCP(Model Context Protocol)エンドポイントを通じてその知識を公開し、人間と AI エージェントがリポジトリのドキュメントを照会できるようにします。

仕組み

  1. インポート: Git URL を指定するか、ZIP をアップロードするか、承認されたローカルディレクトリを指定します。システムはソースを正規化し、ワークスペースを準備します。
  2. 分析と生成: ツリーと既存のリポジトリコンテキストを分析し、設定された LLM プロバイダー(例: OpenAI 互換 API)を使用して、README の要約、概要、wiki カタログ、ドキュメントコンテンツを生成します。複数言語(en、zh、ja、ko、es、fr など)への翻訳はオプションで、並行して実行できます。
  3. エンリッチメント: バックグラウンドワーカーが後続タスク(翻訳、マインドマップ生成(Mermaid)、オプションの Graphify アーティファクト、リポジトリ変更時のスケジュールされた増分更新)を処理します。
  4. 提供: 生成された知識は、/{owner}/{repo} などの公開ルートで公開され、組み込みのチャット UI、埋め込み可能なチャット API、共有リンク、リポジトリスコープの MCP エンドポイント(例: /api/mcp/{owner}/{repo})を介して公開されます。管理者は、管理コンソールからユーザー、ロール、API キー、AI プロバイダー、モデル、スキルなどを管理します。

バックエンドは ASP.NET Core(.NET 10)とバックグラウンドワーカー、フロントエンドは Next.js 16、データストアは SQLite または PostgreSQL、デプロイは Docker Compose です。

対象ユーザー

  • 手動の労力なしに、自動生成された最新のプロジェクトドキュメントを希望する開発チーム。
  • リポジトリの公開ドキュメントが必要なオープンソースメンテナー。
  • ロールベースのアクセス、チャット、AI エージェント向けの MCP 統合を備えた内部ナレッジベースを希望する企業。
  • 複数のリポジトリを使用し、多言語サポートを備えた集中型 wiki を希望する組織。

ハイライト

  • ソースとして Git URL、ZIP アップロード、またはローカルディレクトリを受け入れます。
  • AI 生成の README、概要、wiki カタログ、詳細コンテンツ、翻訳、マインドマップ。
  • 各リポジトリの公開 SEO フレンドリーなルート、専用チャットアシスタント、埋め込み可能なチャット API。
  • AI ツールがリポジトリ知識にアクセスするための MCP エンドポイント(リポジトリスコープまたはグローバル)。
  • リポジトリ、ユーザー、ロール、API キー、AI プロバイダー/モデル、スキル、MCP プロバイダーを管理するための管理コンソール。
  • 処理、翻訳、増分更新、Graphify アーティファクト生成のためのバックグラウンドワーカー。
  • 飛書、QQ、微信、Slack の受信 Webhook のオプションサポート。
  • SQLite または PostgreSQL を使用した Docker Compose デプロイ、Makefile と Sealos オプション。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト