WIP: docs: tell new players to choose Release candidate until v3.0.0 #1216
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
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/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1216
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:docs/rc-until-stable"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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.md, On Windows and Release channels). Linux says to follow the Windows steps.docs/updates-and-saves.md, and one sentence on the channel step indocs/getting-started.md(the site's install page).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.tsexpects 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 channelandchoose the Stable.Checklist
Everyone
type(scope): description) of the status line's type.main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named). Not run this turn; the change is docs and one website test.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers. Assisted-by only; no Cursor co-author line.View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.