README.zh.md

如何编辑文档

English: How to Edit Documentation

欢迎使用 Agora 开发者文档。如果你对我们的文档有任何建议或者问题，欢迎通过以下方式反馈，帮助我们改进。

• 快速编辑现有文档
• 在文档页面提交反馈
• 提交工单

快速编辑现有文档

如果你在浏览文档的时候发现小错误，比如拼写错误、链接错误等，可以通过提交 PR （Pull Request） 快速修改。

1. 在 Agora 开发者中心浏览文档时，可编辑的文档标题右侧会显示 Edit 按钮。点击该按钮打开 GitHub 上的源文件。

   

2. 在 GitHub 页面右上角点击铅笔图标来编辑文档，如下图所示。如果该图标无法点击，你需要先登入 GitHub。

   

3. 在网页编辑器中进行更改。文档内容使用 Markdown 语法。

   文档开头部分内容为系统自动生成的元信息，不支持修改。

   

4. 更改完成后，在页面底部为你的更新输入标题和描述，详细说明修改的原因，然后点击 Commit changes。点击后会跳转到创建 PR 页面。

   

5. 现在需要创建一个 PR，将你的更改合并到现在的文档中。点击 Create a pull request，如下图所示。

   

Agora 文档团队成员会尽快评审并合并你的 PR。

在文档页面提交反馈

如果你对文档的内容有疑问或者有改进建议，或者文档页面上没有 Edit 按钮（比如 API 文档），可以直接在文档页面填写反馈。

1. 在文档页面的右下角，点击反馈按钮。

   

2. 在弹窗中对文档进行评价，在更多建议中详细描述你的问题或建议。如果愿意和我们取得联系，可以填写你的电子邮箱地址。点击提交。

   

收到你的反馈后，我们会尽快确认文档内容是否需要调整。在此过程中，我们可能会通过邮件与你联系，获得更多信息。

提交工单

如果你在使用 Agora 产品时遇到其他问题，可以提交工单，联系 Agora 技术支持。