Russian 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

Только изменения, отправленные в ветку по умолчанию репозитория wiki, становятся видимыми для читателей.

Полезные команды GitHub CLI

Откройте wiki:

gh browse --wiki --repo Appshines/Voice2Win

Проверьте, что функция включена:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

Включите её при необходимости:

gh repo edit Appshines/Voice2Win --enable-wiki

Конвенции содержания

• Группируйте страницы по языкам и используйте единообразные названия в каждом языке.
• Делайте Главную страницу короткой и размещайте подробную информацию на специализированных страницах.
• Обновляйте _Sidebar.md каждый раз, когда страница добавляется, удаляется или переименовывается.
• Отдавайте предпочтение стабильным описаниям вместо версионных скриншотов или точных имен файлов для загрузки.
• Явно документируйте различия между платформами.
• Объясняйте аббревиатуры при первом упоминании на странице.
• Никогда не публикуйте токены для подключения, пароли, приватные логи или личные записи.
• Проверяйте каждую внутреннюю ссылку после переименования страницы.

Официальное руководство GitHub: Добавление или редактирование страниц вики.