fix(docs): the Steam Deck page names places neutrally, and docs changes run the site's checks #1016
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!1016
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:fix/site-steam-deck-names"
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: fix · Risk: low · Tested on: Linux (docs and workflow only) · Needs: none
Why
The website hasn't deployed from main since the Steam Deck page landed (#968). The site check (
website/scripts/check-site.ts) refuses a build whose published text names the game's places, and the page named three of them: Kokiri Village, Hyrule Town and Hyrule Field. So/install/steam-deck/fails the check, and the deploy with it. Earlier fixes such as #731 only rewrite names in the progress items made from players' issues, not in pages the site builds fromdocs/.#968 merged without the check ever running on it, because the Website workflow ran only for changes to
website/and the tested-run sources, not for the other docs the site publishes.How to reproduce
Seen on: Linux, Node 24 (the website build; no game involved)
Settings and switches: defaults
Steps: on main,
cd website && npm ci && npm run build && node scripts/check-site.tsExpected: "Site check passed"
Actual:
/install/steam-deck/: game branding remains in published text, exit code 1, so the Website job doesn't deployWhat changed
The page now uses neutral names, and a docs change now runs the site's build and checks, both on its PR and on its push to main.
docs/steam-deck-playbook.md: "the starting village's benchmark save", "the castle town" (twice), "the main outdoor area", in line with the wordingwebsite/src/lib/public-copy.tsuses for these places..forgejo/workflows/website.yml: the push and pull_requestpathscoverdocs/**andCONTRIBUTING.md(the sourceswebsite/src/content-pages.tspublishes, and the guide images), instead of onlydocs/tested-configurations.mdanddocs/tested/**. A docs merge also deploys right away now, instead of waiting for the hourly rebuild.Measurements
Nothing to measure: a docs and workflow change.
Flags and settings
None
Testing
Tested: before this branch, a build of main at
343a1dfafailednode scripts/check-site.tswith only/install/steam-deck/: game branding remains in published text. On this branch, the check'sGAME_BRANDINGregex finds nothing left indocs/steam-deck-playbook.md. To get the site back up, main as it was just before #968 (0407ae24) was built, passed the site check and was deployed by hand with wrangler.python -I -B tests/run_all.py: left to CI.Not tested: the site build and check on this branch. This PR comes from a fork, so the Website job runs on it once a maintainer adds the
previewlabel.Must be tested:
preview): the build andnpm run checkpass, expecting "Site check passed" with/install/steam-deck/among the pages (Test Farm not needed: the job runs on the label)Risks
What could break: more Website runs, one for each docs PR from a branch of Longshot and each docs merge to main. Each is a preview upload or a deploy of main.
Turning it off: revert the commit
Compatibility: Nothing changes
Issues
See #968
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). Left to CI.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.🤖 Generated with Claude Code
WIP: fix(docs): the Steam Deck page names places neutrally, and docs changes run the site's checksto fix(docs): the Steam Deck page names places neutrally, and docs changes run the site's checks