Ukrainian Maintaining the Wiki

Підтримка вікі

Вікі GitHub зберігаються в окремих Git-репозиторіях. Інтерфейс командного рядка GitHub (gh) може автентифікувати Git, увімкнути або відкрити вікі та надати контекст репозиторію, але наразі не має вбудованої команди для створення чи редагування сторінок вікі.

Одноразове налаштування

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

Автентифікуйтеся та налаштуйте обробку облікових даних Git:

gh auth login
gh auth setup-git

Склонуйте репозиторій вікі:

git clone https://github.com/Appshines/Voice2Win.wiki.git
Set-Location Voice2Win.wiki

Редагування та публікація

Кожен файл Markdown є окремою сторінкою. Ім'я файлу стає адресою сторінки; наприклад, Getting-Started.md публікується як Getting-Started. _Sidebar.md керує бічною навігаційною панеллю.

Після редагування:

git add --all
git commit -m "Update Voice2Win user guide"
git push

Читачі бачать лише зміни, надіслані до гілки за замовчуванням репозиторію вікі.

Корисні команди GitHub CLI

Відкрити вікі:

gh browse --wiki --repo Appshines/Voice2Win

Перевірте, чи функція увімкнена:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

Увімкніть її за потреби:

gh repo edit Appshines/Voice2Win --enable-wiki

Конвенції щодо вмісту

• Напишіть користувацьку документацію англійською.
• Зробіть Головну сторінку короткою та спрямовуйте читачів по детальну інформацію на спеціалізовані сторінки.
• Оновлюйте _Sidebar.md щоразу, коли сторінку додають, видаляють або перейменовують.
• Віддавайте перевагу стабільним описам, а не скріншотам, прив’язаним до певної версії, чи точним назвам файлів для завантаження.
• Документуйте відмінності між платформами чітко.
• Пояснюйте абревіатуру під час її першої появи на сторінці.
• Ніколи не публікуйте токени для створення пари, паролі, приватні журнали або особисті записи.
• Перевіряйте кожне внутрішнє посилання після перейменування сторінки.

Офіційний посібник GitHub: Додавання або редагування сторінок вікі.