Внести вклад в документацию Weblate

Вы можете улучшить страницу документации по своему усмотрению. Сделать это легко, нажав на кнопку Редактировать на GitHub в правом верхнем углу страницы.

Documentation guidelines

Пожалуйста, соблюдайте эти рекомендации при написании:

  1. Не удаляйте часть документации, если она действительна.

  2. Используйте ясный и понятный язык. Вы пишете техническую документацию, а не поэму. Не все читатели документации являются носителями языка, будьте внимательны.

  3. Не бойтесь задавать вопросы, если в чём-то не уверены. Если вопрос появился во время редактирования, не меняйте документацию, пока не получите ответ. Это значит, вы либо меняете, либо спрашиваете. Не делайте и то, и другое одновременно.

  4. Проверьте свои изменения, выполнив описанные действия в соответствии с документацией.

  5. Отправляйте запрос на извлечение(pull request) с изменениями небольшими частями, чтобы облегчить и ускорить их рассмотрение и объединение.

  6. Если вы хотите переписать и изменить структуру большой статьи, сделайте это в два этапа:

    1. Переписать

    2. После того как изменённый вариант будет просмотрен, отшлифован и объединён, измените структуру абзацев в другом запросе на извлечение(pull request).

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

Вы можете перевести документацию.

Documenting permissions, checks, add-ons and automatic suggestions

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

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.