為 Weblate 文件作出貢獻

歡迎您來改進您選擇的文件頁面。點擊符號 編輯在頁面的右上角的github 按鈕上輕鬆進行。

Documentation guidelines

請在寫作時尊重這些指導方針：

1. 如果有效，請勿刪除部分文件。

2. 使用清晰易懂的語言。您正在寫科技作家，而不是一首詩。並非所有Docs讀者都是母語人士，很沉思。

3. Don’t be afraid to ask if you are not certain. If you have to ask about some feature while editing, don’t change its docs before you have the answer. This means: You change or ask. Don’t do both at the same time.

4. 通過在遵循文件時執行描述的操作來驗證您的更改。

5. 將PR與小塊的更改發送，以便更容易，更快地查看和合併。

6. 如果要重寫並更改大文章的結構，請分兩步執行以下操作：

   1. 重寫

   2. 一旦重寫，審核，拋光和合併，改變另一條公關的段落的結構。

Building the documentation locally

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. The build can be performed using ci/run-docs.

提示

You will also need graphviz installed to build the documentation.

Translating the documentation

You can translate the docs.

Documenting permissions, checks, add-ons and automatic suggestions

Several documentation sections use templates generated from the code. The following management commands are available:

• list_addons

• list_permissions

• list_checks

• list_machinery

All these commands output reStructuredText which is used as a template for the documentation. The easiest way to apply changes to the documentation is using visual diff in your editor.