Regenerating the UI screenshots

The README images in docs/ are captured from .harness/index.html, which renders the real webview bundle (media/main.js + main.css) with scripted demo data inside a 430px sidebar frame.

Workflow

1. Build the current bundle: npm run build
2. Serve the repo (background): python3 -m http.server 8321 --bind 127.0.0.1
3. Capture each scene with the IDE browser at http://127.0.0.1:8321/.harness/index.html?scene=<scene>; wait until the page title reads nyx-scene-<scene>-ready, then take a screenshot.

4. Center-crop each capture to the frame (screenshots are centered):

sips -c 1839 1062 docs/<file>.png --out docs/<file>.png

(Values assume the default 714×1024 CSS viewport at ~2.22× scale — if the frame looks cut off, recompute: crop ≈ (430+68)×(780+68) CSS px × scale.)

5. Review the images (read the files) before committing: no debug text, context meter plausible, no real secrets/IPs you don't want public.

Editing the scenes

Demo data lives in .harness/index.html (sceneChat, sceneApproval, sceneMachines) — plain HostToWebview messages. When new UI features ship, extend the relevant scene so the screenshots keep showcasing them.

Releasing nyx-local-ai

Follow this checklist in order. Abort on the first failed step.

Release progress:
- [ ] 1. Bump version everywhere
- [ ] 2. Quality gates
- [ ] 3. Package + local install
- [ ] 4. Commit, tag, push
- [ ] 5. Verify CI release

1. Bump version everywhere

Three places must always carry the same version:

# package.json         → "version": "X.Y.Z"
# README.md            → status line **vX.Y.Z** and all nyx-local-ai-X.Y.Z.vsix mentions
# src/mcp/client.ts    → clientInfo: { version: 'X.Y.Z' }

2. Quality gates

npm run typecheck               # must exit 0
node .harness/smoke.mjs         # must print ALL PASS
node .harness/readme-check.mjs  # must print "README CHECK: ALL PASS"
npm run build                   # must print "[nyx] build complete"

The readme-check verifies all three version locations AND that every setting, command, and tool is documented in README.md — fix any FAIL before continuing (update the README, don't weaken the check).

If parser/edit logic changed in this release, confirm .harness/smoke.mjs covers it before proceeding.

3. Package + local install

npm run package              # check the reported size stays ≈4–6 MB
bash install.sh --editor=cursor --vsix=./nyx-local-ai-X.Y.Z.vsix

Remind the user to run Developer: Reload Window to activate the build.

4. Commit, tag, push

Only commit when the user asked for it. Then:

git tag vX.Y.Z && git push origin main vX.Y.Z

The tag triggers .github/workflows/release.yml, which attaches nyx-local-ai.vsix (stable name), the versioned .vsix, and checksums.txt to the GitHub release — exactly what install.sh/install.ps1 download.

5. Verify CI release

gh run list --repo sthamann/nyx-local-ai --limit 3
gh release view vX.Y.Z --repo sthamann/nyx-local-ai --json assets -q '.assets[].name'

Expected assets: nyx-local-ai.vsix, nyx-local-ai-X.Y.Z.vsix, checksums.txt. If the run failed, read the log (gh run view <id> --log-failed) and fix before announcing the release.