docs: tell new players to choose Release candidate until v3.0.0 #1216

Open
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:docs/rc-until-stable into main
Contributor

Type: docs · Risk: low · Tested on: local website build, Linux, Chromium · Needs: none

Why

A new player following the README presses Build the game and chooses Stable. There is no stable release (the game is still v3.0.0-rc, the launcher a release candidate), so the launcher shows "Not found" and Continue stays unavailable. The same "choose this to play" line is in the updates guide, and the install page's Stable note says "For playing."

Prior work: none for this wording (Stable channel, choose the Stable). #1054 already made the README and the requirements page agree that AVX2 is not required. #638 is the website's release tabs, not these sentences.

What changed

The install steps now say to choose Release candidate until v3.0.0 is out, and they say what Stable does today.

  • README: the Windows step, the channel table, and the "to go back" sentence (README.md, On Windows and Release channels). Linux says to follow the Windows steps.
  • docs: the same channel table in docs/updates-and-saves.md, and one sentence on the channel step in docs/getting-started.md (the site's install page).
  • website: the install page's channel notes in website/src/repo-docs/format-install.ts (Stable: "No release yet."; Release candidate: "Choose this until v3.0.0 is released."). website/tests/repo-docs.test.ts expects the new note.

The 60 GB disk figure in the README and the requirements page already match. The launcher's settings step still stops Build below 45 GB; that change is MagicBeanDev/LongshotLauncher#150, not this PR. AVX2 was left as #1054 wrote it.

Measurements

Verdict: documentation only; nothing to measure.

Flags and settings

None.

Testing

Tested: node --test website/tests/repo-docs.test.ts (6 pass, including the channel-note assertion). Searched the tree for the old "Choose this to play" and "choose the Stable channel" lines; none remain. Local website build of /install/, Stable selected, same scroll in each shot. The version line says information is unavailable because the preview has no live release feed; the channel note and the build step do not depend on it. python -I -B tests/run_all.py on this branch (50fbdd1c): 597 passed, 16 failed, 80 skipped, in 96 s. The same 16 fail on main ac778751. None of them read the install wording:

  • tests/test_bug_report_defaults.py
  • tests/test_crt_options.py
  • tests/test_dlss_feature_size.py
  • tests/test_failed_compile_keeps_objects.py
  • tests/test_guest_imported.py
  • tests/test_lift_lookups.py
  • tests/test_linux_preflight.py
  • tests/test_linux_update.py
  • tests/test_make_game_cache.py
  • tests/test_missing_nup.py
  • tests/test_mods_size_table.py
  • tests/test_pending_guest_import.py
  • tests/test_run_all_changed.py
  • tests/test_vk_occlusion_queries.py
  • tests/test_walk.py
  • tests/test_walk_key.py

Not tested: a run of the game. This change is the install wording.

Must be tested: None.

Risks

What could break: a player who bookmarked a Stable download still finds an empty channel. The text now says so.

Turning it off: revert the commit.

Compatibility: Nothing changes in the game, saves, settings or dependencies. The site publishes the new notes after merge.

Issues

No issue. Searched open, closed and merged pull requests for Stable channel and choose the Stable.

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers. Assisted-by only; no Cursor co-author line.
  • Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen.
  • Docs updated.

Screenshots

Install page, Stable selected. The preview has no live release feed, so the version line says information is unavailable in every shot.

Desktop, dark

Before: main @ ac778751

Before: main @ ac778751, desktop, dark

After: this PR @ 50fbdd1c

After: this PR @ 50fbdd1c, desktop, dark

Desktop, light

Before: main @ ac778751

Before: main @ ac778751, desktop, light

After: this PR @ 50fbdd1c

After: this PR @ 50fbdd1c, desktop, light

Phone, 390 px, dark

Before: main @ ac778751

Before: main @ ac778751, 390 px, dark

After: this PR @ 50fbdd1c

After: this PR @ 50fbdd1c, 390 px, dark

**Type:** docs · **Risk:** low · **Tested on:** local website build, Linux, Chromium · **Needs:** none ## Why A new player following the README presses **Build the game** and chooses **Stable**. There is no stable release (the game is still v3.0.0-rc, the launcher a release candidate), so the launcher shows "Not found" and Continue stays unavailable. The same "choose this to play" line is in the updates guide, and the install page's Stable note says "For playing." Prior work: none for this wording (`Stable channel`, `choose the Stable`). #1054 already made the README and the requirements page agree that AVX2 is not required. #638 is the website's release tabs, not these sentences. ## What changed The install steps now say to choose **Release candidate** until v3.0.0 is out, and they say what Stable does today. - README: the Windows step, the channel table, and the "to go back" sentence (`README.md`, On Windows and Release channels). Linux says to follow the Windows steps. - docs: the same channel table in `docs/updates-and-saves.md`, and one sentence on the channel step in `docs/getting-started.md` (the site's install page). - website: the install page's channel notes in `website/src/repo-docs/format-install.ts` (`Stable`: "No release yet."; `Release candidate`: "Choose this until v3.0.0 is released."). `website/tests/repo-docs.test.ts` expects the new note. The 60 GB disk figure in the README and the requirements page already match. The launcher's settings step still stops Build below 45 GB; that change is https://git.magicbean.dev/MagicBeanDev/LongshotLauncher/pulls/150, not this PR. AVX2 was left as #1054 wrote it. ## Measurements **Verdict:** documentation only; nothing to measure. ### Flags and settings None. ## Testing **Tested:** `node --test website/tests/repo-docs.test.ts` (6 pass, including the channel-note assertion). Searched the tree for the old "Choose this to play" and "choose the Stable channel" lines; none remain. Local website build of `/install/`, Stable selected, same scroll in each shot. The version line says information is unavailable because the preview has no live release feed; the channel note and the build step do not depend on it. `python -I -B tests/run_all.py` on this branch (`50fbdd1c`): 597 passed, 16 failed, 80 skipped, in 96 s. The same 16 fail on main `ac778751`. None of them read the install wording: - `tests/test_bug_report_defaults.py` - `tests/test_crt_options.py` - `tests/test_dlss_feature_size.py` - `tests/test_failed_compile_keeps_objects.py` - `tests/test_guest_imported.py` - `tests/test_lift_lookups.py` - `tests/test_linux_preflight.py` - `tests/test_linux_update.py` - `tests/test_make_game_cache.py` - `tests/test_missing_nup.py` - `tests/test_mods_size_table.py` - `tests/test_pending_guest_import.py` - `tests/test_run_all_changed.py` - `tests/test_vk_occlusion_queries.py` - `tests/test_walk.py` - `tests/test_walk_key.py` **Not tested:** a run of the game. This change is the install wording. **Must be tested:** None. ## Risks **What could break:** a player who bookmarked a Stable download still finds an empty channel. The text now says so. **Turning it off:** revert the commit. **Compatibility:** Nothing changes in the game, saves, settings or dependencies. The site publishes the new notes after merge. ## Issues No issue. Searched open, closed and merged pull requests for `Stable channel` and `choose the Stable`. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. Assisted-by only; no Cursor co-author line. - [x] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. - [x] Docs updated. ## Screenshots Install page, Stable selected. The preview has no live release feed, so the version line says information is unavailable in every shot. ### Desktop, dark **Before: main @ ac778751** ![Before: main @ ac778751, desktop, dark](https://git.magicbean.dev/attachments/218ff783-d06a-4b79-9ff5-6d02c1680c80) **After: this PR @ 50fbdd1c** ![After: this PR @ 50fbdd1c, desktop, dark](https://git.magicbean.dev/attachments/bef2f03b-c737-450d-ac83-9deafb7492e8) ### Desktop, light **Before: main @ ac778751** ![Before: main @ ac778751, desktop, light](https://git.magicbean.dev/attachments/82a33017-7d78-4396-85c6-1c704a313315) **After: this PR @ 50fbdd1c** ![After: this PR @ 50fbdd1c, desktop, light](https://git.magicbean.dev/attachments/eb4b296d-b35d-4e2e-961f-d0210b6490d2) ### Phone, 390 px, dark **Before: main @ ac778751** ![Before: main @ ac778751, 390 px, dark](https://git.magicbean.dev/attachments/fa1ca3dc-9a8e-4389-ac41-fe849f376c77) **After: this PR @ 50fbdd1c** ![After: this PR @ 50fbdd1c, 390 px, dark](https://git.magicbean.dev/attachments/0f55437d-5e43-414e-83ea-4b84bd9b30e6)
docs: tell new players to choose Release candidate until v3.0.0
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 3s
50fbdd1cae
The README told them to choose Stable. There is no stable release, so the launcher shows "Not found" and Continue stays unavailable.

Assisted-by: Agent Hub growth agent
Author
Contributor

Install page screenshots are in the description: before main ac778751 and after 50fbdd1c, desktop dark, desktop light, and 390 px dark. Stable is selected in each. Still WIP until the game-free suite has run.

Install page screenshots are in the description: before main ac778751 and after 50fbdd1c, desktop dark, desktop light, and 390 px dark. Stable is selected in each. Still WIP until the game-free suite has run.
TrashPanda changed title from WIP: docs: tell new players to choose Release candidate until v3.0.0 to docs: tell new players to choose Release candidate until v3.0.0 2026-11-16 19:58:33 +00:00
Author
Contributor

Game-free suite: 597 passed, 16 failed, 80 skipped in 96 s. The same 16 fail on main ac778751. Marked ready.

Game-free suite: 597 passed, 16 failed, 80 skipped in 96 s. The same 16 fail on main ac778751. Marked ready.
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 3s
This pull request doesn't have enough approvals yet. 0 of 1 approvals granted.
Some workflows are waiting to be reviewed.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'docs/rc-until-stable:TrashPanda-docs/rc-until-stable'
git switch 'TrashPanda-docs/rc-until-stable'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
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!1216
No description provided.