README

GitHub Wiki sources

This folder contains the source pages for the HS2-Sandbox GitHub Wiki.

Wiki pages are plain Markdown. GitHub uses Home.md as the wiki front page and _Sidebar.md for the navigation sidebar.

Publish to GitHub Wiki

Option A — sync script (recommended)

From the repository root:

# First time (wiki not on GitHub yet): enable Wikis in repo Settings, then:
.\scripts\sync-github-wiki.ps1 -Init

# Later updates:
.\scripts\sync-github-wiki.ps1

The script derives the wiki URL from your git remote origin (e.g. https://github.com/SuitIThub/HS2-Sandbox.wiki.git), copies all wiki/*.md files, commits, and pushes.

If you see "Repository not found":

1. GitHub → repo Settings → Features → enable Wikis
2. Run .\scripts\sync-github-wiki.ps1 -Init
3. Ensure git is authenticated (gh auth login or Git Credential Manager) if the repo is private

Requirements:

• Git installed
• Push access to the wiki repository
• Wikis enabled on the repository

Option B — manual

git clone https://github.com/SuitIThub/HS2-Sandbox.wiki.git
cp wiki/*.md HS2-Sandbox.wiki/
cd HS2-Sandbox.wiki
git add -A
git commit -m "Sync wiki from main repo"
git push

Keep docs in sync

When updating module behavior, update:

Wiki	In-repo long form
Pose-Browser-*.md	docs/PoseBrowser-HS2Wiki-Manual.md
Anim-Browser-*.md	docs/AnimBrowser-HS2Wiki-Manual.md
Pose-ZIP-Format.md	docs/POSE_ZIP_FORMAT.md
images/SCREENSHOTS.md	Screenshot/GIF checklist for Pose & Anim Browser

HS2Wiki in-game pages are registered separately via PoseBrowserWikiRegistration / AnimBrowserWikiRegistration.

Page naming

GitHub Wiki page titles come from filenames without .md:

• Home.md → wiki home
• Pose-Browser.md → page title "Pose Browser", link [Pose Browser](Pose-Browser)

Use hyphens in filenames; spaces become hyphens in URLs.