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

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

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

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

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

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

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

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

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

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

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

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

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

Документацію також можна редагувати та створювати локально, вимоги Python містяться в групі залежностей docs у pyproject.toml. Збірку можна виконати за допомогою ci/run-docs.

Підказка

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

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

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

Документування дозволів, перевірок, додатків і автоматичних пропозицій

У кількох розділах документації використовуються шаблони, створені з коду. Доступні такі команди керування:

Усі ці команди виводять reStructuredText, який використовується як шаблон для документації. Найпростіший спосіб застосувати зміни до документації — використовувати візуальні відмінності у вашому редакторі.