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

​
我们的文档理念

我们的文档旨在做到

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

​
文档仓库与本地开发

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

​
处理图像和其他静态资产

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

构建过程目前不支持带有相对路径的静态资产。将它们添加到文档时，请确保资产 URL 指向 GitHub 原始文件地址

\!\[Image description\]\(https://raw.githubusercontent.com/meilisearch/documentation/[branch_name]/assets/images/[guide_name]/diagram.png\)

​
如何贡献？

​
问题

Meilisearch 文档的维护者使用GitHub Issues来跟踪任务。有用的问题包括

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

在提出问题或拉取请求之前，请查看我们的开放问题，看看您的问题是否已经存在。如果存在，请留言告知我们您正在等待修复或愿意自己解决。如果不存在，请提出一个新问题，描述问题并告知我们您是否愿意解决。

我们非常欢迎在 Meilisearch 中提出问题，因为它们有助于我们更好地完成工作。十有八九，最有用的贡献是一个简单的 GitHub 问题，它指出问题并提出解决方案。

​
创建您的第一个问题

要提出问题，您需要一个GitHub 帐户。如果需要，请创建一个，然后按照以下步骤操作

  1. 登录您的帐户
  2. 转到Meilisearch 文档仓库
  3. 点击“问题”
  4. 使用搜索栏检查是否有人报告了相同的问题。如果存在，请用 👍 点赞，并且不要创建新问题！
  5. 如果没有人报告您遇到的问题，请点击“新问题”
  6. 撰写一个简短且描述性的标题，然后添加更长的摘要来解释问题。如果您正在报告错误，请务必包含重现错误的步骤，以及您的操作系统和浏览器版本
  7. 点击“提交新问题”
  8. 我们的团队成员应该很快与您联系
  9. 享受大功告成的感觉！🎉

​
拉取请求

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

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

在以下情况下，拉取请求尤其有用

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

在大多数情况下，在创建 PR 之前创建问题是个好主意。这使您能够与文档维护者协调，并找到解决您想要解决问题的最佳方法。

​
创建您的第一个 PR

要创建 PR，您需要一个GitHub 帐户。如果需要，请创建一个，然后按照以下步骤操作

  1. 前往您想要编辑的文档页面，向下滚动，然后点击屏幕左下角的“编辑此页面”。这将带您进入 GitHub
  2. 如果您尚未登录，请立即登录。系统可能会提示您创建一个分支
  3. 使用 GitHub 的文本编辑器更新页面
  4. 向下滚动直到您看到一个名为“提出更改”的框
  5. 填写第一个字段，为您的 PR 提供一个简短而描述性的标题——例如，“修复搜索 API 参考中的拼写错误”
  6. 使用第二个字段添加您提议更改的更详细解释
  7. 点击“提出更改”按钮继续。您应该会看到一个显示“比较更改”的页面
  8. 确保基础仓库设置为 meilisearch/documentation，并且基础分支设置为 main。您可以忽略其余字段
  9. 此屏幕还会显示一个“差异”，让您可以看到您所做的更改与文档网站上当前发布内容的比较
  10. 点击“创建拉取请求”
  11. 恭喜，您已创建您的第一个 PR！ 文档维护者将很快审查您的拉取请求。他们可能会要求您进行更改，因此请留意您的 GitHub 通知
  12. 如果一切顺利，您的工作将合并到 main 分支，并成为官方文档网站的一部分。您现在是 Meilisearch 贡献者了！🚀

​
我们如何审查贡献

​
我们如何审查问题

审查问题时，我们会考虑几个标准

  1. 这项任务对文档维护者来说是优先事项吗？
  2. 文档网站是存放这些信息的最佳位置吗？有时，某个想法可能更适合我们的博客而不是文档，或者链接到外部资源可能比我们自己编写和维护更有效
  3. 如果是错误报告，我们能否重现该错误？

如果用户通过点赞或报告类似问题来表达对某个问题的兴趣，那么文档更有可能为该任务投入资源。

​
我们如何审查 PR

为了审查贡献者 PR，我们首先确保 PR 符合我们的质量标准。

我们提出以下问题

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

没有什么比一个周到且有帮助的 PR 更令我们高兴的了。您的 PR 经常为我们节省时间和精力，它们使文档更加强大。

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

一旦您在此仓库中开启 PR，我们的团队成员将很快进行审查。如果您的 PR 获批，您无需再做任何事。但是，如果在七天内您未回复进一步更改或更多信息的请求，我们将认为该 PR 已放弃并将其关闭。

如果您遇到这种情况并认为存在错误，请告知我们，我们将尽力纠正。

​
为 Meilisearch 做贡献

也有许多直接为 Meilisearch 做贡献的方式，例如

也有许多有价值的方式来支持上述仓库

  • 提供反馈
  • 建议功能
  • 创建测试
  • 修复错误
  • 添加内容
  • 开发功能