README

GitHub Wiki sources

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

GitHub uses Home.md as the wiki front page and _Sidebar.md for the navigation sidebar. Nested folders become nested wiki pages (e.g. pose-browser/Home).

Folder layout

wiki/
  Home.md                 # Wiki front page (must stay at root)
  _Sidebar.md             # Sidebar navigation
  README.md               # This file (maintainers only)
  getting-started/        # Install, requirements, troubleshooting
  hs2/                    # HS2-only modules (CopyScript, Timeline, …)
  pose-browser/           # Pose Browser guide (+ Home.md overview)
  anim-browser/           # Anim Browser guide (+ Home.md overview)
  reference/              # Config files, hotkeys, ZIP format, plugin compat
  developers/             # Architecture, build, CI
  images/
    pose-browser/         # pb-*.png / pb-*.gif assets
    anim-browser/         # ab-*.png / ab-*.gif assets
    SCREENSHOTS.md        # Capture checklist

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 copies the entire wiki/ tree (pages + images/) to the wiki git repository, 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

Option B — manual

git clone https://github.com/SuitIThub/HS2-Sandbox.wiki.git
rsync -av --delete wiki/ HS2-Sandbox.wiki/ --exclude .git
cd HS2-Sandbox.wiki
git add -A
git commit -m "Sync wiki from main repo"
git push

Keep docs in sync

Wiki	In-repo long form
pose-browser/*.md	docs/PoseBrowser-HS2Wiki-Manual.md
anim-browser/*.md	docs/AnimBrowser-HS2Wiki-Manual.md
reference/Pose-ZIP-Format.md	docs/POSE_ZIP_FORMAT.md
images/SCREENSHOTS.md	Screenshot/GIF checklist

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

Page naming & links

GitHub Wiki page paths come from the file path without .md:

File	Wiki link
Home.md	[Home](Home)
pose-browser/Home.md	[Pose Browser](pose-browser/Home)
pose-browser/Groups.md	[Pose groups](pose-browser/Groups)
hs2/Timeline.md	[Timeline](hs2/Timeline)

Use forward slashes in links. Image paths stay relative to the wiki root: images/pose-browser/pb-01-toolbar-icon.png.

Adding screenshots

1. Capture per images/SCREENSHOTS.md
2. Save under wiki/images/pose-browser/ or wiki/images/anim-browser/
3. Run .\scripts\sync-github-wiki.ps1