GitHub wiki 为何被作者称为反模式

The GitHub wiki is an anti-pattern

每过半年，关于'该用 wiki 还是 docs 文件夹'的争论就会重演。经过深入思考，我意识到使用 GitHub wiki 的理由只有一个，而不用的理由却多到让我将其定义为反模式。将文档放在 docs 文件夹中，能确保文档与代码版本同步，支持本地克隆查看，并享受完整的 Pull Request 同行评审流程。此外，你还能利用 GitHub Actions 配合 Vale 进行文档 lint 检查，使用熟悉的工具如 vscode 进行编辑。相比之下，wiki 不仅缺乏品牌定制空间，连图片上传都成问题。对于新项目，将文档置于 docs 文件夹是投入产出比最高的选择，未来文档规模扩大时，迁移至独立仓库也会更加顺畅。