The GitHub wiki is an anti-pattern
4 hours ago
- GitHub wiki 只有一个好处：可以从仓库的任何地方一键访问。
- 在代码旁边使用 /docs 文件夹可以提供版本化的文档、克隆时的本地可用性、通过拉取请求进行同行评审，以及与 GitHub Actions 和 Vale 等工具的集成。
- Wiki 缺少图片上传和品牌定制等功能，并且文档编辑不会像代码一样经过相同的审查流程。
- 推荐做法：将文档存储在 /docs 文件夹中，设置 GitHub Pages（例如使用 just-the-docs 主题），并添加一个 wiki 页面，引导用户访问托管的文档。
- /docs 文件夹为新项目提供了高投入产出比；后续迁移到单独的仓库对于贡献者来说应该是无缝的。