Documentation Guide

First fork document repository, and clone to local.

You can then add or modify the appropriate documents under the corresponding subdirectory in the docs directory. The document format is Markdown and supports some extended syntax, as well as specifically supported syntax Docusaurus: Markdown Features

• Subheadings of the body of the document should use a second or lower level of the title, i.e. or ### and so on, to avoid using a level 1 title.
• For other pages within the document, references can be made directly by something like
• If you add a new document, follow the instructions below to modify the sidebar so that the document can appear in the sidebar.

After committing to Github, create a Pull Request to the ‘main’ branch, waiting for merging by the maintenance team.

The entries for the sidebar are maintained in the file If you need to modify the sidebar, edit this file. Put subpath of docs and doc id into this .json file.

If you want to maintain multilingual translations, clone the document repository to local.

The corresponding language directory is in the directory, such as the English version in i18n/en/docusaurus-plugin-content-docs/current, you can find or create a file corresponding to the directory, note that the id should be the same as the id of the corresponding file in docs. Once the appropriate document has been translated, it can be submitted.

• For code indentation, it needs to set space indent before duplication.
• The hierarchical directory should take the form of Google AIP.
• What is lined with the numeral and the English is the Chinese characters with space.