Documentation Contributing

Prerequisites

Before contributing to this project, please read the Local Deployment Documentation first.

Local Document Deployment Guide

Process Routine

Then, you can write document as usual in the docs/ folder.

Internationalization

You can generate the translation strings for the project documentation by running the gettext_generator.py script. For users whose native language is not Chinese, we recommend first writing the documentation in the language you are familiar with, and then using an AI translation tool to translate it into Chinese and paste it into the document. After that, place your translated content in the corresponding translation for your language.

Please note that generating translation strings is not mandatory, as we have scheduled tasks on GitHub to generate translation strings. Additionally, it is impractical to write all translations for the documentation at the same time; you only need to complete the writing in one language, and the rest will be completed by the developers of the documentation project.

Besides, you can also use a simple script find_untranslate.py to find out all untranslated strings.

Operation Details

If you are creating a new section of the documentation, you need to categorize and place your documents (both .md and .rst files are supported) in the source folder, and then modify the contents of index.rst accordingly, to ensure your documentation can be recognized. Next, build and verify that your documentation is functioning properly.

Thank you for your contribution, and I hope you find joy in participating in the documentation process. If you encounter any issues, please feel free to open an issue at any time!