Document

For those who are having trouble developing, you can also come and help us improve the documentation or work on translations! Our document site is supported by gitbook and it has been interconnected with the github repository.

Writing

Writing tasks involve improving and even adding new project content introductions. The only branch that can be written is en-us.

The writing task is only supported in gitbook. The changes in github repository of en-us will not take effect. To write the document, you can:

• commit a pull request;

• contact the administrator to become a member of our gitbook team.

You need to follow the following principles:

1. Write in English.

2. Accurately explain the external interface and appropriately brief the internal details.

Translation

You can upload your translation results to github repository directly.

For translations in other languages ​​already present, just clone the repository and modify the documents. You need to follow the following principles:

1. Do not edit code other than content.

2. All translations are based on English. The translation of the technical part should be as accurate as possible to be close to the original text. Other contents can be appropriately expressed in localization.

If you wish to create a new translation file for a new language, please contact the administrator and do not edit it without authorization!