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

Ось покрокова інструкція щодо написання вашого внеску у вигляді документації для BeeWare.

Перш ніж приступити до написання документації, переконайтеся, що ви можете скласти документацію і що ви працюєте на гілці.

Оновлення наявної документації

Якщо ви редагуєте існуючі документи, вам потрібно знайти файл у каталозі /docs/en. Структура файлів відповідає структурі сторінок, тому ви можете знайти файл за допомогою URL-адреси документації.

Додавання нової документації

Якщо ви додаєте новий документ, потрібно виконати ще кілька кроків.

Вам потрібно створити документ у відповідній папці каталогу docs/en. Для прикладу припустимо, що ви додаєте новий документ з іменем new_doc.md.

Далі вам потрібно буде оновити файл docs/en/SUMMARY.md, щоб додати до нього ваш новий файл. Файл SUMMARY.md побудований таким чином, щоб, по суті, віддзеркалювати структуру каталогів docs/en, але, що важливіше, він безпосередньо визначає структуру лівої бічної панелі. Якщо ви знайдете розділ, куди плануєте додати new_doc.md, вам не потрібно нічого змінювати у файлі SUMMARY.md, якщо там вказано шлях із символами-замінниками. Наприклад:

- ./шлях/до/каталогу/*

Якщо розділ, у який ви плануєте вставити new_doc.md, є списком окремих посилань у форматі Markdown, вам потрібно буде додати явне посилання на ваше посилання. Наприклад:

- [Мій новий документ](new_doc.md)

Складання документації

Тепер ви можете відкрити потрібний файл у редакторі та почати писати.

У нас є посібник зі стилю документації, в якому викладено наші рекомендації щодо написання документації для BeeWare.

Коли ви будете задоволені своєю новою документацією, ви зможете надіслати запит на злиття із запропонованими змінами.