Основне
Ми винесли всю документацію Stevious в окремий репозиторій. Тепер документація стала відкритішою для спільноти, а кожен охочий може допомогти нам її покращувати.
Якщо ви помітили помилку, неточність, застарілу інформацію або вважаєте, що певної інструкції не вистачає, то ви можете самостійно запропонувати зміни.
Як долучитися?
Для цього не потрібно мати спеціальні права на сайт. Ви можете створити власну копію репозиторію, внести необхідні зміни та відкрити Pull Request.
Процес простий:
- Створіть Fork репозиторію документації.
- Знайдіть потрібний файл або створіть нову сторінку.
- Внесіть необхідні зміни.
- Зробіть коміт і створіть Pull Request.
- Опишіть, що саме було змінено та навіщо.
- Після перевірки зміни будуть додані до документації.
Що можна покращувати?
Ви можете виправляти помилки та неточності, доповнювати існуючі інструкції, додавати нові сторінки, оновлювати застарілу інформацію, покращувати структуру тексту та повідомляти про відсутню інформацію.
Ми хочемо, щоб документація була не просто довідником від команди, а спільним ресурсом, у розвиток якого може зробити внесок кожен.
Для роботи з документацією використовується Markdown/MDX. На сторінці про документацію також є короткий гайд із прикладами синтаксису та оформлення.
Навіть якщо ви не маєте великого досвіду роботи з GitHub, це хороший спосіб зробити свій перший внесок у проєкт.
Докладна інструкція: https://stvworlds.win/docs/about_docs
Репозиторій документації: https://github.com/stvworlds/STVdocs.
