Посприяйте документуванню Weblate

Будемо раді вашій участі в удосконаленні будь-яких сторінок документації. Зробити це просто: натисніть кнопку Редагувати на GitHub у верхньому правому куті вибраної сторінки.

Інструкції з документації

Будь ласка, дотримуйтеся таких настанов під час написання тексту:

  1. Не вилучайте частини документації, якщо вона є чинною.

  2. Користуйтеся чіткою і зрозумілою мовою. Ви пишете технічну документацію, не поему. Не усі читачі документації володіють англійською, будьте уважні.

  3. Не бійтеся спитати, якщо щось не зрозуміло. Якщо ви запитали про якусь можливість під час редагування, не змінюйте документацію щодо неї, доки не отримаєте відповіді. Це означає: або змінюйте, або питайте. Не виконуйте обидві дії одночасно.

  4. Перевіряйте ваші зміни, виконуючи описані дії відповідно до документації.

  5. Надсилайте запити щодо об’єднання малими фрагментами, щоб спростити і пришвидшити їхнє рецензування та злиття до сховища.

  6. Якщо вам хочеться переписати або змінити структуру великого розділу, робіть це у два кроки:

    1. Переписування

    2. Щойно переписування буде рецензовано, виправлено та злито до сховища, змініть структуру абзаців в іншому запиті щодо об’єднання.

Створення документації на місці

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. If you already use the full development environment, uv sync --all-extras --dev is enough. For documentation work only, uv sync --group docs is sufficient.

The recommended local workflow is:

make -C docs update-docs
./ci/run-docs

The ci/run-docs wrapper builds the documentation with warnings treated as errors.

Підказка

Вам також знадобиться встановити graphviz для створення документації.

Переклад документації

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

Updating generated documentation snippets

Several documentation sections use templates generated from the code. The preferred way to refresh them is:

make -C docs update-docs

This target regenerates the snippets currently used by the documentation, including:

  • add-on events, built-in add-ons, and common add-on parameters

  • machine translation services

  • file format parameters and file format feature tables

  • permissions and built-in roles

  • checks and check flags

Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, Додатки includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.

If you need to regenerate only one part, the individual management commands are documented in Команди керування, and the exact commands used by update-docs are listed in docs/Makefile.