Japanese Maintaining the Wiki

Wikiの維持管理

GitHubのWikiは個別のGitリポジトリです。GitHubコマンドラインインターフェイス（gh）はGitの認証、Wikiの有効化またはオープン、リポジトリコンテキストの提供が可能ですが、現在のところ、Wikiページを作成または編集するためのネイティブコマンドは含まれていません。

一度限りのセットアップ

GitHubがクローン用にWikiリポジトリを公開する前に、最初のページが存在している必要があります。このWikiはすでに初期化されているため、メンテナはローカルのワークフローを直接使用できます。

Gitの認証とクレデンシャル処理を設定します：

gh auth login
gh auth setup-git

Wikiリポジトリをクローンします：

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

編集と公開

各Markdownファイルは1ページです。ファイル名がページアドレスになります。たとえば、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の公式ガイド：Wikiページの追加または編集。