该文档网站托管在GitHub公共仓库中，使用Next.js构建，采用MDX编写，并部署在Vercel上。

​
我们的文档理念

我们的文档力求做到：

  • 高效：不想浪费任何人的时间
  • 易理解：阅读这些内容不需要英语母语水平或计算机科学学位
  • 全面：文档网站应包含使用Meilisearch所需的所有信息
  • 开源：这是由Meilisearch用户为Meilisearch用户提供的资源

​
文档仓库与本地开发

Meilisearch文档仓库仅存储文档网站的内容。由于构成网站的代码存放在另一个仓库中，因此无法在本地运行文档副本。

​
处理图片和其他静态资源

当为Meilisearch文档贡献内容时，请将截图、图片、GIF和视频存储在/assets目录下的相应位置。

当前构建流程不支持使用相对路径的静态资源。在文档中添加这些资源时，请确保资源URL指向GitHub原始文件地址：

\!\[图片描述\]\(https://raw.githubusercontent.com/meilisearch/documentation/[branch_name]/assets/images/[guide_name]/diagram.png\)

​
如何贡献？

​
问题反馈

Meilisearch 文档维护团队使用 GitHub Issues 来跟踪任务。有价值的 issue 包括：

  • 通知文档团队关于内容不准确、过时或令人困惑的情况
  • 新功能请求，例如版本控制或嵌入式控制台
  • 新内容请求，例如新的指南和教程

在提交 issue 或 PR 之前，请先查看我们的 开放 issue 列表，确认是否已有相关问题的记录。如果存在，请留言告知我们您正在等待修复或愿意自行解决。如果没有，请新建一个 issue 描述问题，并说明您是否愿意参与解决。

我们非常重视 issue 反馈，因为它们能帮助我们更好地工作。十次中有九次，最有价值的贡献就是一个简单的 GitHub issue，它指出了问题并提出了解决方案。

​
创建您的第一个 issue

要提交 issue，您需要一个 GitHub 账号。如果需要请先注册，然后按照以下步骤操作：

  1. 登录您的账号
  2. 前往 Meilisearch 文档仓库
  3. 点击 “Issues” 标签
  4. 使用搜索栏检查是否有人已经报告了相同问题。如果有，请用 👍 点赞，不要创建重复的 issue！
  5. 如果没有人报告您遇到的问题，点击 “New issue”
  6. 编写简洁描述性的标题，然后添加更详细的说明。如果是报告错误，请确保包含重现步骤以及您的操作系统和浏览器版本
  7. 点击 “Submit new issue”
  8. 我们的团队成员会尽快回复您
  9. 享受任务完成的成就感吧！🎉

​
拉取请求 (Pull requests)

您也可以通过提交拉取请求来改进文档。

拉取请求（简称”PRs”）是请求将更改集成到 GitHub 仓库中的方式。在我们的文档上创建 PR 最简单的方法是使用每页左下角的”编辑此页面”链接。

在以下情况下特别适合使用拉取请求：

  • 解决现有问题
  • 修复小错误，如拼写错误或失效链接
  • 创建或改进您非常熟悉的内容——例如，关于如何将 Meilisearch 与您精通的工具集成的指南

在大多数情况下，创建问题后再提交 PR 是个好主意。这可以让您与文档维护者协调，找到解决您想处理问题的最佳方式。

​
创建你的第一个 PR

要创建一个 PR（Pull Request），你需要一个 GitHub 账号。如果没有请先注册，然后按照以下步骤操作：

  1. 前往你想编辑的文档页面，滚动到底部，点击屏幕左下角的”Edit this page”。这将带你进入 GitHub
  2. 如果尚未登录，请先登录。系统可能会提示你创建一个 fork
  3. 使用 GitHub 的文本编辑器更新页面内容
  4. 向下滚动直到看到名为”Propose changes”的方框
  5. 填写第一个字段，为你的 PR 起一个简短描述性的标题——例如”修复搜索 API 参考中的拼写错误”
  6. 在第二个字段中添加更详细的修改说明
  7. 点击”Propose changes”按钮继续。你会看到一个显示”Comparing changes”的页面
  8. 确保基础仓库(base repository)设置为meilisearch/documentation，基础分支(base branch)设置为main。其余字段可以忽略
  9. 这个页面还会显示”diff”（差异对比），让你看到当前文档网站内容与你所做修改的差异
  10. 点击”Create pull request”
  11. 恭喜，你完成了第一个 PR！ 文档维护者会尽快审核你的拉取请求。他们可能会要求修改，所以请留意你的 GitHub 通知
  12. 如果一切顺利，你的修改将被合并到main分支，并成为官方文档网站的一部分。你现在是 Meilisearch 的贡献者了！🚀

​
我们的贡献审核流程

​
我们的 issue 评审流程

在 评审 issue 时，我们会考虑以下几个标准：

  1. 该任务是否是文档维护者的优先事项？
  2. 文档网站是否是存放该信息的最佳场所？有时某些内容可能更适合发布在我们的博客而非文档中，或者链接到外部资源比我们自己编写和维护更有效
  3. 如果是错误报告，我们能否复现该错误？

如果用户通过点赞或报告类似问题表现出对某个 issue 的兴趣，文档团队就更有可能为该任务分配资源。

​
我们的 PR 审核流程

对于审核贡献者的 PR，我们首先确保 PR 符合我们的质量标准。

我们会提出以下问题：

  1. 信息是否准确？
  2. 是否易于理解？
  3. 代码示例能否无错误运行？它们是否帮助用户理解我们的解释？
  4. 英文表达是否清晰简洁？非母语者能否理解？
  5. 语法是否完美？是否存在拼写错误？
  6. 能否在不丢失重要信息的前提下精简文本？
  7. 建议的修改是否需要同步更新文档网站的其他页面？
  8. 对于新增内容，文章是否放在正确位置？文档中的其他文章是否应该链接到它？

没有什么比收到深思熟虑且有帮助的 PR 更让我们高兴的了。您的 PR 常常为我们节省时间和精力，并使文档更加完善。

我们对 PR 贡献的唯一主要要求是作者能在合理时间内响应沟通请求。

当您在本仓库提交 PR 后，我们的团队成员会尽快进行审核。如果您的 PR 获得批准，您无需再做其他操作。但是，如果七天内您未响应进一步修改或补充信息的请求，我们将视该 PR 为已放弃并关闭它。

如果这种情况发生在您身上且您认为存在误会，请告知我们，我们将尽力解决问题。

​
为 Meilisearch 做贡献

您可以通过多种方式直接为 Meilisearch 做出贡献，例如：

还有多种方式可以为上述代码库提供有价值的支持：

  • 提供反馈意见
  • 建议新功能
  • 编写测试用例
  • 修复错误
  • 添加内容
  • 开发新功能