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

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

Type: docs · Risk: low · Tested on: website unit test only · 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 warns at 45 GB (Disk.BuildBytes); that is a launcher change, 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.

Not tested: the full game-free suite, a website build, and screenshots of the install page. The game does not run this change.

Must be tested: a local website build of the install page, so the new channel notes can be screenshotted (dark, light, 390 px) before this leaves WIP.

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). Not run this turn; the change is docs and one website test.
  • 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. The install-page notes still need a local website build.
  • Docs updated.
**Type:** docs · **Risk:** low · **Tested on:** website unit test only · **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 warns at 45 GB (`Disk.BuildBytes`); that is a launcher change, 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. **Not tested:** the full game-free suite, a website build, and screenshots of the install page. The game does not run this change. **Must be tested:** a local website build of the install page, so the new channel notes can be screenshotted (dark, light, 390 px) before this leaves WIP. ## 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`. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). Not run this turn; the change is docs and one website test. - [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. - [ ] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. The install-page notes still need a local website build. - [x] Docs updated.
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
PR description / Description follows the template (pull_request_target) Successful in 4s
Website / Website on Cloudflare (pull_request_target) Has been skipped
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
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
PR description / Description follows the template (pull_request_target) Successful in 4s
Website / Website on Cloudflare (pull_request_target) Has been skipped
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
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.