docs: add DeepWiki badge - #4035
Conversation
Astro-Han
left a comment
There was a problem hiding this comment.
Approve.
I checked the precedent rather than assuming: this badge is already common across the foundation — apache/pulsar, apache/pinot, apache/ozone, apache/opendal, apache/seatunnel, apache/shenyu, apache/hertzbeat, apache/fluss, apache/cloudberry, apache/amoro, apache/iceberg-cpp and the whole apache/hugegraph family all carry it. So there is no foundation-level objection here, and I don't have a project-level one either.
Two small things, neither blocking:
- Please mirror this into
README.zh-CN.md. This repository maintains the English and Chinese READMEs side by side, and the Chinese one carries the same badge row (README.zh-CN.md:32). Adding it in only one leaves Chinese readers without the link. Happy to approve again once that's in. - Cosmetic: the badge currently lands after the macOS/Windows/Linux trio, splitting the platform badges from each other. Placing it right after the license badge keeps the three platform badges adjacent.
AI-assisted review disclosure: Claude Code ran the cross-repository badge search; I verified the hit list and the README badge structure myself.
Done :) |
|
@M4n5ter - pulling you in on this one, since you have more context on this class of tooling than I do. Two things worth your judgement, neither of which I want to decide alone:
The change itself is clean and both READMEs are in sync - this is purely about whether we want it and in what form. |
EnglishThanks for pulling me in. I am in favor of adding it, with a small visible trust boundary. Please keep the official <sub>Third-party AI-generated docs · <a href="./docs/README.md">non-authoritative</a></sub>中文感谢邀请。我支持加入,但建议用一行很小的可见文字明确其信任边界。 请保留官方 <sub>第三方 AI 生成文档 · <a href="./docs/README.md">非权威来源</a></sub> |
M4n5ter
left a comment
There was a problem hiding this comment.
Verified the final README placement and the visible third-party AI documentation disclosure in both languages.
Summary
Add the DeepWiki badge to the repository README.
DeepWiki maintains automatically generated documentation for the Maka codebase. Adding the badge serves two purposes:
DeepWiki provides automatically generated documentation and code cross-references for Maka, giving contributors another way to navigate and understand the codebase.
DeepWiki is free for open source repositories.
Verification
The badge renders correctly and links to the Maka DeepWiki
AI use
Select exactly one:
Tool(s) and scope:
Checklist
Does this PR entail a change in behavior?