参与文档编写
此文档网站托管在公共 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 来跟踪任务。有帮助的问题包括
- 通知文档团队有关不准确、过时或令人困惑的内容
- 请求新功能，例如版本控制或嵌入式控制台
- 请求新内容，例如新的指南和教程
在创建 Issue 或 PR 之前，请查看我们的 开放 Issue，看看是否已存在与您的问题相关的 Issue。如果已存在，请留下评论，告知我们您正在等待修复或愿意自行解决。如果不存在，请创建一个新的 Issue 来描述问题，并告知我们您是否愿意参与解决。
我们热爱 Meilisearch 的 Issue，因为它们帮助我们更好地完成工作。十次中有九次，最有用的贡献是一个简单的 GitHub Issue，它指出了问题并提出了解决方案。
创建您的第一个 Issue
要创建 Issue，您需要一个 GitHub 账户。如有必要，请创建一个，然后按照以下步骤操作
- 登录您的账户
- 进入 Meilisearch 文档仓库
- 点击“Issues”
- 使用搜索栏检查是否有人报告了相同的问题。如果有人报告过，请点赞👍并**不要创建新的 Issue**！
- 如果没有人报告您遇到的问题，请点击“New issue”
- 编写一个简短且描述性的标题，然后添加一个更长的摘要来解释问题。如果您报告的是错误，请务必包含重现错误的步骤，以及您的操作系统和浏览器版本
- 点击“Submit new issue”
- 我们的团队成员应该会 尽快回复您
- 享受完成工作后的成就感！🎉
Pull Request
您还可以通过创建 Pull Request来改进文档。
Pull Request（简称“PR”）是将更改集成到 GitHub 存储库的请求。在我们文档中创建 PR 的最简单方法是使用每个页面底部左侧的“Edit this page”链接。
Pull Request 特别适合以下情况：
- 解决一个 已存在的 Issue
- 修复小错误，例如错别字或损坏的链接
- 创建或改进您非常了解的内容，例如，关于如何将 Meilisearch 与您掌握的工具集成的指南
在大多数情况下，最好在创建 PR 之前 创建 Issue。这使您可以与文档维护者协调，并找到解决您要解决问题的最佳方法。
创建您的第一个 PR
要创建 PR，您需要一个 GitHub 账户。如有必要，请创建一个，然后按照以下步骤操作
- 转到您要编辑的文档页面，向下滚动，然后点击屏幕左下角的“Edit this page”。这将带您进入 GitHub
- 如果您尚未登录，请立即登录。系统可能会提示您创建一个 fork
- 使用 GitHub 的文本编辑器更新页面
- 向下滚动，直到您看到一个名为“Propose changes”的框
- 填写第一个字段，为您的 PR 提供一个简短且描述性的标题，例如“Fix typo in search API reference”
- 使用第二个字段添加对您提议的更改的更详细说明
- 点击“Propose changes”按钮继续。您应该会看到一个显示“Comparing changes”的页面
- 确保基本存储库设置为
meilisearch/documentation，并且基本分支设置为main。您可以忽略其余字段 - 此屏幕还将显示“diff”，使您可以查看与当前在文档网站上发布的内容相比，您所做的更改
- 点击“Create pull request”
- **恭喜，您创建了您的第一个 PR！** 文档维护者将很快审查您的 Pull Request。他们可能会要求您进行更改，因此请留意您的 GitHub 通知
- 如果一切正常，您的工作将合并到
main分支中，并成为官方文档网站的一部分。您现在是 Meilisearch 贡献者！🚀
我们如何审查贡献
我们如何审查 Issue
当**审查 Issue**时，我们会考虑以下几个标准
- 此任务对文档维护者来说是否优先级较高？
- 文档网站是否适合放置此信息？有时，一个想法可能更适合发布在我们的博客上而不是文档中，或者链接到外部资源可能比我们自己编写和维护它更有效
- 如果是错误报告，我们能否重现错误？
如果用户通过点赞或报告类似问题来表示对 Issue 的关注，则文档更有可能为此任务分配资源。
我们如何审查 PR
对于**审查贡献者的 PR**，我们首先确保 PR 符合我们的**质量标准**。
我们会提出以下问题
- 信息是否**准确**？
- 信息是否**易于理解**？
- 代码示例是否能无错误运行？它们是否帮助用户理解我们正在解释的内容？
- 英语是否**清晰简洁**？非英语母语人士能否理解？
- 语法是否完美？是否存在任何错别字？
- 我们能否在**不丢失任何重要信息**的情况下缩短文本？
- 建议的更改是否需要更新文档网站中的其他页面？
- 对于新内容，文章是否位于正确的位置？文档中的其他文章是否应该链接到它？
没有什么比一个经过深思熟虑且有帮助的 PR 更能让我们感到高兴了。您的 PR 通常可以节省我们的时间和精力，并且使文档变得**更加强大**。
我们对 PR 贡献的唯一主要要求是作者在合理的时间范围内回复沟通请求。
在您在此存储库中打开 PR 后，我们的团队成员会很快过来审查它。如果您的 PR 获得批准，则无需您进一步操作。但是，**如果在七天内您没有回复进一步更改或更多信息的请求，我们将认为 PR 已放弃并将其关闭**。
如果发生这种情况，并且您认为存在某些错误，请告知我们，我们会尝试纠正这种情况。
为 Meilisearch 做贡献
还有许多方法可以为 Meilisearch 直接做出贡献，例如
还有许多有价值的方法可以支持上述存储库
- 提供反馈
- 建议功能
- 创建测试
- 修复错误
- 添加内容
- 开发功能