本文档网站托管在公共 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. 点击“Issues”
  4. 使用搜索栏检查是否有人报告了相同的问题。如果有人报告了，请点赞 👍 并且不要创建新问题！
  5. 如果没有人报告您遇到的问题，请点击“New issue”
  6. 编写一个简短且描述性的标题，然后添加一个更长的摘要来解释问题。如果您正在报告错误，请务必包含重现错误的步骤，以及您的操作系统和浏览器版本
  7. 点击“Submit new issue”
  8. 我们的团队成员应该会很快与您联系
  9. 享受完成工作的喜悦！🎉

​
拉取请求

您还可以通过提交拉取请求来改进文档。拉取请求（简称“PRs”）是集成更改到 GitHub 仓库的请求。在我们的文档上创建 PR 的最简单方法是使用每页左下角的“编辑此页面”链接。当您想执行以下操作时，拉取请求特别有用：
  • 解决现有问题
  • 修复小错误，例如错别字或损坏的链接
  • 创建或改进您非常了解的内容——例如，关于如何将 Meilisearch 与您已掌握的工具集成的指南
在大多数情况下，最好在创建 PR 之前创建一个问题。这允许您与文档维护者协调，并找到解决您想要解决问题的最佳方法。

​
创建您的第一个拉取请求 (PR)

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

​
我们如何评审贡献

​
我们如何评审问题

在审查问题时，我们考虑几个标准
  1. 这项任务是否是文档维护者的优先事项？
  2. 文档网站是此信息的最佳位置吗？有时，一个想法可能在我们的博客上比在文档中更好，或者链接到外部资源可能比我们自己编写和维护更有效
  3. 如果是错误报告，我们能否重现错误？
如果用户通过点赞或报告类似问题来表示对某个问题的兴趣，文档就更有可能将资源投入到该任务中。

​
我们如何评审 PRs

对于审查贡献者 PRs，我们首先确保 PR 符合我们的质量标准。我们提出以下问题：
  1. 信息是否准确？
  2. 是否易于理解？
  3. 代码示例是否无错误运行？它们是否帮助用户理解我们正在解释的内容？
  4. 英文是否清晰简洁？非母语人士能否理解？
  5. 语法是否完美？是否有任何错别字？
  6. 我们能否在不丢失任何重要信息的情况下缩短文本？
  7. 建议的更改是否需要更新文档网站中的其他页面？
  8. 如果是新内容，文章是否在正确的位置？文档中的其他文章是否应该链接到它？
没有什么比一个周到且有帮助的 PR 更让我们高兴的了。您的 PR 经常为我们节省时间和精力，它们使文档更加强大。我们对 PR 贡献的唯一主要要求是作者在合理的时间范围内回复通信请求。一旦您在此仓库中打开 PR，我们的团队成员之一将很快进行审查。如果您的 PR 获得批准，则无需您进一步操作。但是，如果在七天内您没有回复进一步更改或更多信息的请求，我们将认为 PR 已放弃并将其关闭。如果您遇到这种情况，并且您认为存在一些错误，请告知我们，我们将尝试纠正这种情况。

​
贡献 Meilisearch

还有许多直接贡献 Meilisearch 的方式，例如 还有许多有价值的方式支持上述仓库
  • 提供反馈
  • 提出功能建议
  • 创建测试
  • 修复错误
  • 添加内容
  • 开发功能
© . This site is unofficial and not affiliated with Meilisearch.