#17411·netty

从仓库文件生成文档

作者: vpelikh创建于 2026年9月10日更新于 2026年9月10日

目前,GitHub Wiki 上的 Netty 文档存放在一个独立的 Git 存储库中(`netty.wiki.git`)。这个存储库不属于主 `netty/netty` 存储库的一部分,GitHub 不支持对 Wiki 存储库提交的拉取请求。因此,没有写入权限的外部贡献者无法通过标准的分支和拉取请求工作流程提交文档改进。目前,要修改 Wiki 的唯一方法是维护者(或具有协作者权限的人)手动克隆 Wiki 存储库,进行编辑并推送。这为希望帮助改进文档的社区成员带来了很大的障碍。我知道这不是一个重要问题,但这可能会极大地改进文档。例如,`Native transports` 页面已经过时了 - 它根本没有提及 `io_uring`,如果我能通过 Pull Request 提交修改,我将很乐意修复这个问题。这个问题表明,应该将文档源文件存储在主存储库中,并自动从中生成文档,这样文档贡献就可以通过与代码相同的 Pull Request 审查流程进行。