Написання документації

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

Обов’язково також ознайомтеся з workflow guidelines, особливо якщо ви новачок у використанні Git або GitHub.

Лінії підказки

Ось принципи та вказівки, яких ми прагнемо дотримуватися, щоб створити доступну документацію.

• Вказівки щодо змісту
• Інструкції з написання
• Створення документальних зображень і відео
• Documentation contribution checklist

Написання посібника

У цих статтях пояснюється, як зробити внесок у цю саму документацію та як створити локальну онлайн-версію для тестування.

• Внески до документації
• Складання посібника зі Sphinx

Класні довідкові посібники

На наступних сторінках ви знайдете посилання на клас.

Оскільки посилання включено в редактор Godot, його вихідні файли є частиною репозиторію godot. Ми використовуємо XML-файли для його написання, тому процес створення довідника класу відрізняється від написання онлайн-посібника.

• Внесок у довідку про клас
• Базовий буквар класу

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

Спільнота постійно працює над тим, щоб зробити Godot та його документацію доступними для більшої кількості людей. Локалізація документації — це колосальна й постійна робота, у якій ви можете брати участь.

• Редактор і локалізація документації