Chinese: 如何编辑文档

Welcome to the open-source documentation of Agora. If you have questions or suggestions regarding our documentation, choose one of the following options.

• Quick edits
• Submit feedback on the documentation
• Submit a ticket

If you find minor issues such as spelling errors or broken links, you can quickly propose an edit by submitting a pull request (PR).

1. When browsing Agora Developer Center documentation, you will see the Edit button if the quick edit option is available. Click this button to open the source file on GitHub.

   

2. On the GitHub page, click the pencil icon to edit the document. If the icon is grayed out, you need to log in to GitHub first.

   

3. Make updates in the browser editor. Agora documentation supports Markdown syntax.

   The initial section of the document is the metadata, which cannot be modified.

   

4. After you finish your edit, scroll to the bottom of the page. Enter a title and detailed description of your changes, and then click Commit changes. The page redirects to the Open a pull request page.

   

5. Now you need to create a PR to merge your changes to the current document. Scroll down the page to review your changes. If you are satisfied, click Create a pull request.

   

We will review and merge your PR as soon as possible.

If you have questions about any part of our documentation or suggestions for improving it, or if the quick edit option is unavailable (for example, in the API Reference), you can submit feedback on the relevant page.

1. Click the feedback button on the bottom right corner of the page.

   

2. In the pop-up window, give the document a positive (thumbs up) or negative (thumbs down) rating, and then describe your feedback in detail under More Suggestions. Leave your email address if you would like us to contact you. Then click Submit.

   

After receiving your feedback, we will confirm whether the document needs to be updated; if so, we will make the appropriate changes. During this process, we may contact you via email for more information.

If you have more complicated questions regarding the documentation, we recommend that you submit a ticket.