Maintaining the Wiki

Maintaining the Wiki

GitHub wikis are separate Git repositories. The GitHub Command Line Interface (gh) can authenticate Git, enable or open a wiki, and provide repository context, but it does not currently include a native command for creating or editing wiki pages.

One-time setup

The first page must exist before GitHub exposes the wiki repository for cloning. This Wiki is already initialized, so maintainers can use the local workflow directly.

Authenticate and configure Git credential handling:

gh auth login
gh auth setup-git

Clone the wiki repository:

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

Edit and publish

Each Markdown file is one page. The filename becomes the page address; for example, Getting-Started.md is published as Getting-Started. _Sidebar.md controls the navigation sidebar.

After editing:

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

Only changes pushed to the wiki repository's default branch become visible to readers.

Useful GitHub CLI commands

Open the wiki:

gh browse --wiki --repo Appshines/Voice2Win

Verify that the feature is enabled:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

Enable it if necessary:

gh repo edit Appshines/Voice2Win --enable-wiki

Content conventions

• Write user documentation in English.
• Keep Home short and route detailed information to focused pages.
• Update _Sidebar.md whenever a page is added, removed, or renamed.
• Prefer stable descriptions over version-specific screenshots or exact download filenames.
• Document platform differences explicitly.
• Explain an abbreviation the first time it appears on a page.
• Never publish pairing tokens, passwords, private logs, or personal recordings.
• Test every internal link after renaming a page.

GitHub's official guide: Adding or editing wiki pages.