docs(guides): illustrate installation, settings and save transfer #264

Open

bibiburl wants to merge 9 commits from bibiburl/Longshot:docs/guide-screenshots into main

pull from: bibiburl/Longshot:docs/guide-screenshots

merge into: MagicBeanDev:main

MagicBeanDev:main

Conversation 7 Commits 9 Files changed 25 +2334 -22

bibiburl commented 2026-11-13 18:27:18 +00:00

Member

• Copy link
• Copy Markdown

Why

Players need to recognize the controls described in the install, settings and save-transfer guides. This PR adds seven UI-only images beside the relevant actions, full-size links, and a maintained source-review check so later menu or Launcher changes flag illustrations that need review.

What changed

• Add actual rc.3 Launcher welcome, empty Saves and import-chooser captures, plus a Graphics example rendered from the real rc.3 menu code with bundled fonts and a plain background.
• Add three real Launcher-view fixture captures: home with Manage saves, game-file selection with Browse… / Next, and import confirmation with FROM / TO, replacement warning, Keep settings, backup location and Import.
• Keep one image set under docs/images/guide/; canonical Markdown and the website use the same files. Add useful alt text, platform/version/state captions and full-size links.
• Place welcome before file selection; settings beside menu navigation; import chooser inside step 3 and confirmation inside step 4. Keep essential actions and warnings in selectable text.
• Provide isolated menu and Launcher capture helpers, integrity/source review checks, 14 regression tests and a read-only Forgejo workflow on every PR and main push.
• Fix filesystem URL decoding when copying site assets from paths containing spaces. Restore HDR visibility wording recognized by the existing README/menu guard.

Flags and settings

No game/runtime settings change. Optional menu capture takes --source, --vulkan-headers, --output and --cxx; Launcher capture takes --source, --output and --dotnet (SDK 10). The guard uses --review-sources and --launcher-source for source review. Reproduction and maintenance instructions are in docs/images/guide/README.md.

The new Launcher fixture renders the real rc.3 Avalonia views in memory using Headless + Skia and locked dependencies. It copies clean tracked source into a temporary directory and applies two explicit fixture adapters: disable game-file discovery, and supply illustrative requirement results. Hardware/tools states are labeled illustrative in the guide. Build registration and save files are synthetic text. Import is previewed through the real dry-run path; the transfer command is never invoked, and file/directory fingerprints verify the preview made no changes. No UI image is a composite or a text replacement.

Measurements

Baseline: main @ ae96bad3b5 (2026-11-13).
This PR: docs/guide-screenshots @ 112bd10.
Linux x86_64; Node v22.23.4; pinned npm lockfile; Launcher fixture .NET SDK 10.0.301. Documentation/fixture checks only; no gameplay performance claim.

Evidence	Baseline	This PR
Shared guide PNGs	0	7
Source and integrity guard	Absent	All 7 pass against reviewed local menu sources and exact rc.3 Launcher checkout
Screenshot checker regression tests	Absent	14 pass
Website screenshot integration tests	Absent	3 pass: byte identity/path handling, full-size links, rendered transfer-step placement
Site source guard	Fails: README names no HDR tone-mapper visibility condition	Corrected wording passes

The settings image was captured from release source 0c74253d4c6ed08d57e4f3aa8ce8634c4c017085. A current-source fixture rebuild at 6d8a424 differs only in its top-left version text (pixel-difference bounds x71–245, y25–39). Reviewed render-scale changes do not affect the pictured Game’s own/Auto state; other changed dependencies are unused renderer declarations. Original capture provenance and later review are recorded separately. All Launcher images are reviewed against exact rc.3 source 028ad66d343db0502acdcc005609a31ea890ef79.

Website build passed: 14 pages in 38.22 s. Site checks passed: 802 local links/assets, anchors and edit links; all 8 Node test files passed. Validation used an identical source copy in /tmp because the original NTFS mount treats Astro’s colon-containing virtual-module names as alternate data streams. No dependency change was needed. The network-enabled build completed without unavailable-data/fetch failures; an existing duplicate 404-route warning remains. Full interleaved baseline/branch and rendered-page comparisons remain incomplete; this PR is WIP.

Testing

Passed: website build and site checks above; all seven images inspected for private paths, real save data and game assets; exact Launcher rc.3 tag/artifact provenance; all image/source/fixture hashes against reviewed sources; 14 checker tests; 3 website screenshot-integration tests; both locked Launcher restores and fixture build/render; menu fixture compiled/rendered Graphics, Audio and Controls from rc.3 and current source (only Graphics published); git diff --check.

Repository game-free suite: initial run before the final placement pass: 458 passed, 7 failed, 65 skipped. Six failures were sandbox restrictions (sanitizer/process/socket checks); all six passed on a targeted rerun outside that restriction. The remaining bake-portability test lacked pinned zstandard==0.25.0; its 5 tests passed after installing that package in a temporary environment. The 65 platform/toolchain-dependent skips remain untested. The screenshot guard and website checks were rerun after this pass; the entire game-free suite was not repeated.

Not tested: live game/Vulkan presentation equivalence of the software-rendered settings example; rendered website desktop/mobile, light/dark, keyboard and search inspection (browser access host unavailable). No game was built, launched or measured, and no real save transfer was performed. The fixture’s plain-text executable marker was never run.

Needs other testers: rendered browser review of affected pages before ready. No game-performance testing is requested for this documentation change.

Screenshots

The welcome Build version is release-list metadata. Settings values are illustrative, not recommendations. Rendered guide-page comparisons remain pending.

Screenshot placement review

A UI reviewer and a documentation designer independently reviewed the canonical guides, website transforms and initial four images. Their three highest-value additional captures are now applied. A follow-up review inspected all three new images and their placement; its Next button-label correction is included. These are source/image reviews, not rendered usability tests.

Guide	Placement now applied	Reader question
Install	Welcome immediately after Build, then file selector beside Browse… / Next	Where do I start, and how do I select the game?
Settings	Graphics example after navigation shortcuts, before persistence/restart text	Where are tabs, setting values and contextual help?
Transfer	Registered-build home beside Manage saves	Where do I find save management?
Transfer	Saves overview after the preparation checklist	Which action imports or exports, and why is Export disabled when empty?
Transfer	Chooser inside step 3; confirmation inside step 4 before Import	What do I select, and what will be replaced?

Every image has a full-size link. Tests verify chooser and confirmation remain in the correct numbered HTML steps. The placement matrix and acceptance criteria also live in docs/images/guide/README.md. Windows-specific transfer imagery remains conditional on a validated Windows capture; no Linux screen is presented as Windows evidence. Additional settings galleries and repeated images on the updates overview are unnecessary for this pass.

Before ready, inspect desktop and 360–390px widths, both themes, browser zoom, keyboard links and search. Verify readable controls/captions and no horizontal overflow. Passing hashes and HTML tests do not establish visual usability.

Risk and rollback

A bad asset mapping could break images; tests cover file identity and links, while rendered inspection remains required. The source manifest conservatively flags shared dependencies; newly introduced dependencies still require author/reviewer attention. The Launcher fixture is illustrative and uses documented source adapters, so its output is distinguished from the official binary captures. Revert the documentation/fixture change to remove it; no runtime or save migration is involved.

Reviewer notes

Developer-maintained update plan

The implementation and full maintenance procedure live in docs/images/guide/README.md.

1. Longshot PR check: every PR compares recorded menu, font, ImGui and fixture source hashes. Changed inputs fail with REVIEW REQUIRED and the affected screenshot filename. The author reviews labels, defaults, navigation, availability and adjacent guide text, then recaptures or records why the old image is still accurate. Never automatically refresh hashes to clear a failure.
2. Launcher companion check: Launcher is a separate repository. Its PR/release job must check out the proposed Launcher commit and an explicit Longshot docs revision, then run the same guard with --review-sources --launcher-source CHECKOUT. Missing source is not approval. Changed Launcher UI requires review and, where necessary, a linked companion docs PR. This PR documents the counterpart; it does not install it in Launcher.
3. Release gate: repeat the cross-repository check against the exact final Launcher release commit. Keep that commit, docs revision and output in release review; do not rely on an earlier candidate or silently use a moving branch.
4. Required merge checks: a maintainer must verify the new Forgejo workflow actually runs, demonstrate failure with a changed recorded UI file, and make its status required in branch protection. The Launcher maintainer must similarly enable its companion check. Those settings are not changed by this PR.
5. Human review: the UI author owns freshness, the reviewer verifies retained/replaced image evidence and written steps, and the docs maintainer checks rendered pages before release. Preserve original capture release/binary/source hashes; newer review provenance is separate. Store images only in Longshot.

The Longshot workflow and guard are included. Successful remote execution, required branch protection and the Launcher counterpart are explicitly outstanding maintainer setup, so this PR does not claim complete cross-repository enforcement.

Issues

Follows #104 (comment).

Checklist

For everyone

• One topic.
• The title is a Conventional Commit (type(scope): description).
• Rebased on current main at branch creation (ae96bad3); refresh before ready if it moves.
• python -I -B tests/run_all.py run and passing in one complete invocation: initial run and corrected targeted reruns reported above; skips remain.
• Tested in the game, or what wasn't is named under Testing.
• Testing filled in: what was tested, what wasn't, and what needs other testers.
• Measured: full interleaved baseline/branch and rendered comparisons remain incomplete; WIP.
• No game files, dumps, build output or generated source files. Published PNGs contain project UI only.
• third_party/ untouched.
• The license is OK: new source under repository GPL-3.0-or-later; bundled redistributable fonts with existing notices; no decompiled or game-extracted material.

If applicable

• AI assistance recorded with Assisted-by: trailers.
• Screenshots for a change that shows on screen: seven UI captures included; rendered website comparison remains pending.
• Docs updated.

## Why Players need to recognize the controls described in the install, settings and save-transfer guides. This PR adds seven UI-only images beside the relevant actions, full-size links, and a maintained source-review check so later menu or Launcher changes flag illustrations that need review. ## What changed - Add actual rc.3 Launcher welcome, empty Saves and import-chooser captures, plus a Graphics example rendered from the real rc.3 menu code with bundled fonts and a plain background. - Add three real Launcher-view fixture captures: home with **Manage saves**, game-file selection with **Browse… / Next**, and import confirmation with **FROM / TO**, replacement warning, **Keep settings**, backup location and **Import**. - Keep one image set under `docs/images/guide/`; canonical Markdown and the website use the same files. Add useful alt text, platform/version/state captions and full-size links. - Place welcome before file selection; settings beside menu navigation; import chooser inside step 3 and confirmation inside step 4. Keep essential actions and warnings in selectable text. - Provide isolated menu and Launcher capture helpers, integrity/source review checks, 14 regression tests and a read-only Forgejo workflow on every PR and main push. - Fix filesystem URL decoding when copying site assets from paths containing spaces. Restore HDR visibility wording recognized by the existing README/menu guard. ## Flags and settings No game/runtime settings change. Optional menu capture takes `--source`, `--vulkan-headers`, `--output` and `--cxx`; Launcher capture takes `--source`, `--output` and `--dotnet` (SDK 10). The guard uses `--review-sources` and `--launcher-source` for source review. Reproduction and maintenance instructions are in `docs/images/guide/README.md`. The new Launcher fixture renders the real rc.3 Avalonia views in memory using Headless + Skia and locked dependencies. It copies clean tracked source into a temporary directory and applies two explicit fixture adapters: disable game-file discovery, and supply illustrative requirement results. Hardware/tools states are labeled illustrative in the guide. Build registration and save files are synthetic text. Import is previewed through the real dry-run path; the transfer command is never invoked, and file/directory fingerprints verify the preview made no changes. No UI image is a composite or a text replacement. ## Measurements Baseline: main @ ae96bad3b553e5f930ea407615e3af5a4a723fd8 (2026-11-13). This PR: docs/guide-screenshots @ 112bd10. Linux x86_64; Node v22.23.4; pinned npm lockfile; Launcher fixture .NET SDK 10.0.301. Documentation/fixture checks only; no gameplay performance claim. | Evidence | Baseline | This PR | |---|---|---| | Shared guide PNGs | 0 | 7 | | Source and integrity guard | Absent | All 7 pass against reviewed local menu sources and exact rc.3 Launcher checkout | | Screenshot checker regression tests | Absent | 14 pass | | Website screenshot integration tests | Absent | 3 pass: byte identity/path handling, full-size links, rendered transfer-step placement | | Site source guard | Fails: README names no HDR tone-mapper visibility condition | Corrected wording passes | The settings image was captured from release source `0c74253d4c6ed08d57e4f3aa8ce8634c4c017085`. A current-source fixture rebuild at `6d8a424` differs only in its top-left version text (pixel-difference bounds x71–245, y25–39). Reviewed render-scale changes do not affect the pictured Game’s own/Auto state; other changed dependencies are unused renderer declarations. Original capture provenance and later review are recorded separately. All Launcher images are reviewed against exact rc.3 source `028ad66d343db0502acdcc005609a31ea890ef79`. Website build passed: 14 pages in 38.22 s. Site checks passed: 802 local links/assets, anchors and edit links; all 8 Node test files passed. Validation used an identical source copy in `/tmp` because the original NTFS mount treats Astro’s colon-containing virtual-module names as alternate data streams. No dependency change was needed. The network-enabled build completed without unavailable-data/fetch failures; an existing duplicate 404-route warning remains. Full interleaved baseline/branch and rendered-page comparisons remain incomplete; this PR is WIP. ## Testing **Passed:** website build and site checks above; all seven images inspected for private paths, real save data and game assets; exact Launcher rc.3 tag/artifact provenance; all image/source/fixture hashes against reviewed sources; 14 checker tests; 3 website screenshot-integration tests; both locked Launcher restores and fixture build/render; menu fixture compiled/rendered Graphics, Audio and Controls from rc.3 and current source (only Graphics published); `git diff --check`. **Repository game-free suite:** initial run before the final placement pass: 458 passed, 7 failed, 65 skipped. Six failures were sandbox restrictions (sanitizer/process/socket checks); all six passed on a targeted rerun outside that restriction. The remaining bake-portability test lacked pinned `zstandard==0.25.0`; its 5 tests passed after installing that package in a temporary environment. The 65 platform/toolchain-dependent skips remain untested. The screenshot guard and website checks were rerun after this pass; the entire game-free suite was not repeated. **Not tested:** live game/Vulkan presentation equivalence of the software-rendered settings example; rendered website desktop/mobile, light/dark, keyboard and search inspection (browser access host unavailable). No game was built, launched or measured, and no real save transfer was performed. The fixture’s plain-text executable marker was never run. **Needs other testers:** rendered browser review of affected pages before ready. No game-performance testing is requested for this documentation change. ## Screenshots        The welcome Build version is release-list metadata. Settings values are illustrative, not recommendations. Rendered guide-page comparisons remain pending. ## Screenshot placement review A UI reviewer and a documentation designer independently reviewed the canonical guides, website transforms and initial four images. Their three highest-value additional captures are now applied. A follow-up review inspected all three new images and their placement; its **Next** button-label correction is included. These are source/image reviews, not rendered usability tests. | Guide | Placement now applied | Reader question | |---|---|---| | Install | Welcome immediately after **Build**, then file selector beside **Browse… / Next** | Where do I start, and how do I select the game? | | Settings | Graphics example after navigation shortcuts, before persistence/restart text | Where are tabs, setting values and contextual help? | | Transfer | Registered-build home beside **Manage saves** | Where do I find save management? | | Transfer | Saves overview after the preparation checklist | Which action imports or exports, and why is Export disabled when empty? | | Transfer | Chooser inside step 3; confirmation inside step 4 before **Import** | What do I select, and what will be replaced? | Every image has a full-size link. Tests verify chooser and confirmation remain in the correct numbered HTML steps. The placement matrix and acceptance criteria also live in `docs/images/guide/README.md`. Windows-specific transfer imagery remains conditional on a validated Windows capture; no Linux screen is presented as Windows evidence. Additional settings galleries and repeated images on the updates overview are unnecessary for this pass. Before ready, inspect desktop and 360–390px widths, both themes, browser zoom, keyboard links and search. Verify readable controls/captions and no horizontal overflow. Passing hashes and HTML tests do not establish visual usability. ## Risk and rollback A bad asset mapping could break images; tests cover file identity and links, while rendered inspection remains required. The source manifest conservatively flags shared dependencies; newly introduced dependencies still require author/reviewer attention. The Launcher fixture is illustrative and uses documented source adapters, so its output is distinguished from the official binary captures. Revert the documentation/fixture change to remove it; no runtime or save migration is involved. ## Reviewer notes ### Developer-maintained update plan The implementation and full maintenance procedure live in `docs/images/guide/README.md`. 1. **Longshot PR check:** every PR compares recorded menu, font, ImGui and fixture source hashes. Changed inputs fail with `REVIEW REQUIRED` and the affected screenshot filename. The author reviews labels, defaults, navigation, availability and adjacent guide text, then recaptures or records why the old image is still accurate. Never automatically refresh hashes to clear a failure. 2. **Launcher companion check:** Launcher is a separate repository. Its PR/release job must check out the proposed Launcher commit and an explicit Longshot docs revision, then run the same guard with `--review-sources --launcher-source CHECKOUT`. Missing source is not approval. Changed Launcher UI requires review and, where necessary, a linked companion docs PR. This PR documents the counterpart; it does not install it in Launcher. 3. **Release gate:** repeat the cross-repository check against the exact final Launcher release commit. Keep that commit, docs revision and output in release review; do not rely on an earlier candidate or silently use a moving branch. 4. **Required merge checks:** a maintainer must verify the new Forgejo workflow actually runs, demonstrate failure with a changed recorded UI file, and make its status required in branch protection. The Launcher maintainer must similarly enable its companion check. Those settings are not changed by this PR. 5. **Human review:** the UI author owns freshness, the reviewer verifies retained/replaced image evidence and written steps, and the docs maintainer checks rendered pages before release. Preserve original capture release/binary/source hashes; newer review provenance is separate. Store images only in Longshot. The Longshot workflow and guard are included. Successful remote execution, required branch protection and the Launcher counterpart are explicitly outstanding maintainer setup, so this PR does not claim complete cross-repository enforcement. ## Issues Follows https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/104#issuecomment-12784. ## Checklist ### For everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`). - [x] Rebased on current `main` at branch creation (ae96bad3); refresh before ready if it moves. - [ ] `python -I -B tests/run_all.py` run and passing in one complete invocation: initial run and corrected targeted reruns reported above; skips remain. - [x] Tested in the game, or what wasn't is named under Testing. - [x] Testing filled in: what was tested, what wasn't, and what needs other testers. - [ ] Measured: full interleaved baseline/branch and rendered comparisons remain incomplete; WIP. - [x] No game files, dumps, build output or generated source files. Published PNGs contain project UI only. - [x] `third_party/` untouched. - [x] The license is OK: new source under repository GPL-3.0-or-later; bundled redistributable fonts with existing notices; no decompiled or game-extracted material. ### If applicable - [x] AI assistance recorded with `Assisted-by:` trailers. - [ ] Screenshots for a change that shows on screen: seven UI captures included; rendered website comparison remains pending. - [x] Docs updated.

bibiburl added 1 commit 2026-11-13 18:27:18 +00:00

docs(guides): add shared launcher screenshot and provenance ... c745cf59d2

Assisted-by: Codex (OpenAI)

bibiburl added 1 commit 2026-11-13 18:28:38 +00:00

docs(saves): illustrate launcher transfer controls ... 9253f97a81

Assisted-by: Codex (OpenAI)

bibiburl commented 2026-11-13 18:28:57 +00:00

Author

Member

• Copy link
• Copy Markdown

Added Saves and manual-import screenshots in 9253f97, plus exact rc.3 button labels and confirmation steps. The release-tag source confirms Windows saves remain per build while Linux saves are shared; the captions make that distinction explicit. All three PNG asset copies pass a byte-for-byte check. Settings fixture, source drift check and full website validation remain in progress.

Added Saves and manual-import screenshots in 9253f97, plus exact rc.3 button labels and confirmation steps. The release-tag source confirms Windows saves remain per build while Linux saves are shared; the captions make that distinction explicit. All three PNG asset copies pass a byte-for-byte check. Settings fixture, source drift check and full website validation remain in progress.

bibiburl commented 2026-11-13 18:31:23 +00:00

Author

Member

• Copy link
• Copy Markdown

Added the developer maintenance plan: local menu/UI/font changes will trigger screenshot source review; Launcher UI/release authors get an explicit cross-repository review command and companion-docs responsibility. The planned Launcher hook is documented as a follow-up integration, not claimed as installed. Capture provenance remains separate from later human review records.

Added the developer maintenance plan: local menu/UI/font changes will trigger screenshot source review; Launcher UI/release authors get an explicit cross-repository review command and companion-docs responsibility. The planned Launcher hook is documented as a follow-up integration, not claimed as installed. Capture provenance remains separate from later human review records.

bibiburl added 1 commit 2026-11-13 18:34:41 +00:00

docs(guides): flag UI drift and document screenshot ownership ... 6d8a424e70

Assisted-by: Codex (OpenAI)

bibiburl commented 2026-11-13 18:35:31 +00:00

Author

Member

• Copy link
• Copy Markdown

Implemented the maintenance plan in 6d8a424: an offline PNG/source-fingerprint checker, 12 passing regression tests and a read-only workflow definition for every PR/main push. Changed source identifies each affected screenshot; missing external Launcher source reports NOT CHECKED. The README assigns UI author/reviewer/docs maintainer responsibilities and separates the planned Launcher counterpart and required branch-protection configuration from what this PR actually adds. Settings integration and final validation remain WIP.

Implemented the maintenance plan in 6d8a424: an offline PNG/source-fingerprint checker, 12 passing regression tests and a read-only workflow definition for every PR/main push. Changed source identifies each affected screenshot; missing external Launcher source reports NOT CHECKED. The README assigns UI author/reviewer/docs maintainer responsibilities and separates the planned Launcher counterpart and required branch-protection configuration from what this PR actually adds. Settings integration and final validation remain WIP.

bibiburl added 2 commits 2026-11-13 18:37:14 +00:00

test(guides): require both menu capture source fingerprints ... 6cc7a153bc

Assisted-by: Codex (OpenAI)

docs(guides): pin the planned launcher review job to its release commit ... 5afe0a17a8

Assisted-by: Codex (OpenAI)

bibiburl commented 2026-11-13 18:37:33 +00:00

Author

Member

• Copy link
• Copy Markdown

Maintenance follow-ups require fingerprints for both UI capture source files (13 tests now pass) and specify that the planned Launcher-side review job must check out and verify the exact candidate/final-release commit SHA. Missing Launcher review and branch-protection setup remain explicitly separate from this PR’s local guard.

Maintenance follow-ups require fingerprints for both UI capture source files (13 tests now pass) and specify that the planned Launcher-side review job must check out and verify the exact candidate/final-release commit SHA. Missing Launcher review and branch-protection setup remain explicitly separate from this PR’s local guard.

bibiburl added 1 commit 2026-11-13 18:38:35 +00:00

docs(guides): capture the real settings menu without game assets ... 5832ee32e0

Render maintained menu code with bundled fonts and deterministic UI-only state; record capture and reviewed sources separately. Share the image with the settings guide and validate site paths containing spaces.

Assisted-by: Codex (OpenAI)

bibiburl added 1 commit 2026-11-13 18:40:06 +00:00

fix(guides): distinguish complete and skipped source reviews ... 58bb5b1732

Assisted-by: Codex (OpenAI)

bibiburl added 1 commit 2026-11-13 18:41:36 +00:00

docs(guides): track launcher fonts and save behavior dependencies ... 2e4b08009f

Assisted-by: Codex (OpenAI)

bibiburl commented 2026-11-13 18:46:12 +00:00

Author

Member

• Copy link
• Copy Markdown

Added the real-menu UI-only settings fixture and fourth shared guide image. All image/source checks and 13 checker tests pass; the site builds 14 pages and passes 792-link/asset validation plus all 8 website test files. The developer plan now specifies every-PR source review, a separately installed Launcher companion job, exact-release checks, and required branch protection. Those cross-repository setup steps are not claimed as enabled. Original capture provenance is preserved; current menu comparison changes only the version label. WIP remains for browser-rendered review because the browser access host is unavailable.

Added the real-menu UI-only settings fixture and fourth shared guide image. All image/source checks and 13 checker tests pass; the site builds 14 pages and passes 792-link/asset validation plus all 8 website test files. The developer plan now specifies every-PR source review, a separately installed Launcher companion job, exact-release checks, and required branch protection. Those cross-repository setup steps are not claimed as enabled. Original capture provenance is preserved; current menu comparison changes only the version label. WIP remains for browser-rendered review because the browser access host is unavailable.

bibiburl commented 2026-11-13 19:10:40 +00:00

Author

Member

• Copy link
• Copy Markdown

Two independent agents reviewed screenshot placement: a UI reviewer and a documentation designer. Their documented plan puts the import chooser inside step 3 before confirmation, the welcome capture directly beside Build, and the settings layout beside navigation. It recommends full-size links and prioritizes a synthetic-state import-confirmation capture. The PR description records exact anchors, reader questions, proposed versus existing assets and acceptance criteria. This was a review pass: guide placement and image files are unchanged; rendered mobile/theme review remains outstanding.

Two independent agents reviewed screenshot placement: a UI reviewer and a documentation designer. Their documented plan puts the import chooser inside step 3 before confirmation, the welcome capture directly beside Build, and the settings layout beside navigation. It recommends full-size links and prioritizes a synthetic-state import-confirmation capture. The PR description records exact anchors, reader questions, proposed versus existing assets and acceptance criteria. This was a review pass: guide placement and image files are unchanged; rendered mobile/theme review remains outstanding.

bibiburl added 1 commit 2026-11-13 19:37:49 +00:00

docs(guide): illustrate Launcher decisions beside their steps ... 112bd103c1

Add real-view captures for Manage saves, game file selection and import confirmation with isolated synthetic state. Keep capture dependencies and source review in the screenshot manifest, and verify image links and transfer-step placement.

Assisted-by: Codex (OpenAI)

bibiburl commented 2026-11-13 19:39:04 +00:00

Author

Member

• Copy link
• Copy Markdown

Added the three clarity captures in 112bd10: Manage saves navigation, game-file selection, and import confirmation. Each sits beside its action with a full-size link. The real Launcher views render isolated synthetic state; import remains a dry-run preview. Updated the capture provenance and developer-maintained review plan. All 7 image/source checks, 14 guard tests, and the website build/check pass (14 pages, 802 links/assets, 8 Node test files). WIP remains for rendered browser review and maintainer-side required-check setup.

Added the three clarity captures in 112bd10: Manage saves navigation, game-file selection, and import confirmation. Each sits beside its action with a full-size link. The real Launcher views render isolated synthetic state; import remains a dry-run preview. Updated the capture provenance and developer-maintained review plan. All 7 image/source checks, 14 guard tests, and the website build/check pass (14 pages, 802 links/assets, 8 Node test files). WIP remains for rendered browser review and maintainer-side required-check setup.

bibiburl changed title from WIP: docs(guides): illustrate installation, settings and save transfer to docs(guides): illustrate installation, settings and save transfer 2026-11-13 19:49:32 +00:00

Some checks failed

Hide checks

CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped

Details

CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped

Details

CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped

Details

Third-party parts / The same as upstream (pull_request) Has been skipped

Details

Website / Website on Cloudflare (pull_request) Has been skipped

Details

CI / Conventional Commit title (pull_request) Successful in 4s

Details

CI / Workflow lint (actionlint) (pull_request) Successful in 6s

Details

Guide screenshots / Guide images and local UI source review (pull_request) Successful in 6s

Details

Third-party parts / As their notes say (pull_request) Successful in 8s

Details

PR description / Description follows the template (pull_request_target) Failing after 4s

Details

This pull request has changes conflicting with the target branch.

• README.md

View command line instructions

Manual merge helper

Use this merge commit message when completing the merge manually.

Merge commit title docs(guides): illustrate installation, settings and save transfer (#264)

Merge commit body Reviewed-on: https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/264

docs(guides): illustrate installation, settings and save transfer (#264) Reviewed-on: https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/264 Copy merge commit message

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u 'docs/guide-screenshots:bibiburl-docs/guide-screenshots'

git switch 'bibiburl-docs/guide-screenshots'

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

area/accessibility

Barriers for people with disabilities

  

area/audio

Sound and music

  

area/input

Controllers, keyboard, mouse

  

area/install

Installing, updating, building from your game

  

area/menu

In-game menu and settings

  

area/renderer

Vulkan renderer, shaders, effects

  

area/saves

Save files

  

area/upscaling

DLSS, FSR, frame generation

  

good first issue

A good start for a new contributor

  

gpu/amd

AMD GPUs

  

gpu/igpu

Integrated GPUs

  

gpu/intel

Intel GPUs

  

gpu/nvidia

NVIDIA GPUs

  

help wanted

Extra hands or knowledge wanted

  

kind

bug

Something doesn't work as it should

  

kind

chore

Build, CI, dependencies, tidying

  

kind

docs

Documentation

  

kind

feature

A new feature or an improvement

  

kind

performance

Frame rate, frame time, loading, memory

  

kind

question

A question rather than a change

  

needs measurements

Waiting for before/after measurements

  

platform/linux

Linux only

  

platform/steam-deck

Steam Deck

  

platform/windows

Windows only

  

preview

Maintainers: deploy a preview of this PR's website (read its changes first). Removed after the run.

  

priority

critical

Crashes, data loss, or blocks most players

  

priority

high

Important: next in line

  

priority

low

Nice to have

  

status

blocked

Waits on something else first

  

status

confirmed

Reproduced or agreed on

  

status

duplicate

Already reported or proposed

  

status

invalid

Not a problem in this project

  

status

needs-info

Waiting for more information from the reporter

  

status

wontfix

Will not be worked on

  

testing wanted

Wanted: a test on other hardware (posts a test request in #test-requests)

No labels

area/accessibility

area/audio

area/input

area/install

area/menu

area/renderer

area/saves

area/upscaling

good first issue

gpu/amd

gpu/igpu

gpu/intel

gpu/nvidia

help wanted

kind

bug

kind

chore

kind

docs

kind

feature

kind

performance

kind

question

needs measurements

platform/linux

platform/steam-deck

platform/windows

preview

priority

critical

priority

high

priority

low

status

blocked

status

confirmed

status

duplicate

status

invalid

status

needs-info

status

wontfix

testing wanted

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

MagicBeanDev/Longshot!264

No description provided.