使用 DeepWiki 索引开源项目,效果体验!

95 阅读3分钟

早上醒来,看到朋友圈和技术交流群,很多都在讨论DeepWiki。我拿我的 4 个开源项目来试试,看看效果如何。

  • 初级 Go 实战项目 fastgo
  • 中级 Go 实战项目 miniblog
  • 高级 Go 实战项目 iam
  • 专家级 Go 实战项目onex

DeepWiki 是什么?

一句话解释:GitHub 版 Deep Research

使用方法超级简单,只需将你想看的 GitHub 仓库链接中的 github 替换成 deepwiki,按下回车,就可以打开这个仓库的 DeepWiki 专属页面了,完全免费,无需注册。

fastgo:快速入门 Go 项目开发

项目描述:以最小的学习难度,教会你尽快了解如何开发一个功能相对完备的高质量 Go 项目。

索引文档地址: deepwiki.com/onexstack/f…

2108 行的小项目,反倒一直没索引出来。可能测试的人太多?

不等了,我们继续看其他项目的索引效果。

miniblog:功能全面,小而美的高质量 Go 实战项目

索引文档地址:deepwiki.com/onexstack/m…

索引动图如下图所示:

下面是 DeepWiki 画的一张系统架构图:

认证鉴权流程图如下:

iam:企业级的 Go 语言实战项目:认证和授权系统

索引效果如下:

onex:高质量、易维护、高扩展的企业级云原生项目

再来看下,deepwiki.com/onexstack/o… 项目。这个项目拥有 16 万行代码。来看下,索引效果。

索引文档地址为:deepwiki.com/onexstack/o…

DeepWiki 索引的 OneX 项目的描述:

OneX 是一款云原生平台,采用类似 Kubernetes 的模式与架构来管理分布式区块链挖矿资源。借助 OneX,用户可以便捷地在多条区块链网络之间进行矿机的部署、扩缩容与运维管理。平台内置完备的用户管理体系、资源控制器以及自定义资源定义(CRD),为区块链挖矿场景提供了一站式解决方案。

onex 的系统架构图:

DeepWiki 画的核心组件列表及功能:

<其中一个异步任务组件的索引架构图:

总结

DeepWiki 很强,能够快速生成一个项目的文档,而且面面俱到,内容很多,,并且其中很多内容具有参考价值。

这里,来总结下使用感受:

  • 实用非常方便,只需要将 github.com/onexstack/o… 中的 github 换成 deepwiki 即可;

  • 索引文档格式标准、规范,很具有参考意义;

  • DeepWiki 能索引16万行代码的大型项目,很牛叉;

  • DeepWiki 索引的不少内容描述不准确。比如对于 onex 项目的描述,跟我对项目的描述和愿景差别很大;

  • 索引文档中,有不少错误,例如:

  • 相较于作者自己编写的文档和架构图,少了很多作者的意图,缺少的这部分,可能是作者想表达的;

感觉目前最好的方式,还是作者参考 DeepWiki 的输出,梳理出自己的项目介绍文档,对外展示一个包含作者意图、更准确的项目文档。

如果你想系统学习这些开源项目,欢迎加入我的知识星球:云原生AI实战营