“我该用 Wiki 还是 GitHub 上的 docs 文件夹？”这一讨论每隔几个月就会重新浮现。遵循 Shawn Wang 的“三次击球出局”原则，作者认为在 GitHub 上使用 Wiki 是一种反模式。Wiki 唯一的优势是始终可用，但它缺乏版本控制、本地访问、同行评审和品牌化选项。相比之下，/docs 文件夹将文档与代码集成，支持版本控制，启用拉取请求评审，并可配合 Vale 和拼写检查等工具使用。由于 Wiki 不支持上传，图片必须托管在别处。要发布文档，请结合 GitHub Pages 和 just-the-docs 等主题使用 /docs 文件夹。避免使用 gh-pages 分支，以使文档随代码一起版本化。随着项目增长，文档可能迁移到单独的仓库，但贡献者届时已习惯该工作流。作者欢迎在 Twitter 上提供反馈。