系统概述
OpenDeepWiki 是一个使用 AI 技术自动分析代码仓库并生成文档的系统。它能够克隆代码仓库,分析其结构,并使用 AI 模型生成详细的文档内容,包括项目概述、目录结构和详细的代码解释。

OpenDeepWiki 核心流程
核心组件
- KernelFactory:负责创建和配置 AI 内核实例,支持不同的模型提供者(OpenAI、AzureOpenAI、Anthropic)。
- WarehouseTask:后台服务,处理代码仓库队列,管理仓库的克隆和文档生成流程。
- DocumentsService:核心文档处理服务,负责:
- 解析代码仓库目录结构
- 生成项目概述
- 创建文档目录结构
- 生成详细文档内容
- 处理提交记录
- Prompt:提供各种 AI 提示模板,用于不同的文档生成任务。
- GitService:处理代码仓库的克隆和版本管理。
主要流程
- 仓库提交:用户提交代码仓库地址,系统将其存入待处理队列。
- 仓库克隆:WarehouseTask 从队列中取出任务,克隆代码仓库到本地。
- 目录分析:系统分析仓库文件结构,必要时使用 AI 进行智能过滤(对于大型仓库)。
- 文档目录生成:
- 先使用 AI 生成思考目录(GenerateThinkCatalogue)
- 然后基于思考结果生成结构化的文档目录(GenerateCatalogue)
- 内容生成:系统为每个目录项生成详细内容,包括:
- 读取相关依赖文件
- 使用 AI 生成文档内容
- 修复生成内容中的 Mermaid 图表语法
- 存储文档文件
- 提交记录处理:对于 Git 仓库,系统还会分析并生成更新日志,记录提交历史。
关键 AI 交互
- 智能目录过滤:使用 AI 优化大型仓库的目录结构。
- 项目概述生成:分析整个仓库,生成高层次的项目概述。