docs: the game, not its title or OoT #723

Merged
HumanBean merged 1 commit from HumanBean/Longshot:docs/the-game-not-its-title into main 2026-11-15 06:37:08 +00:00
Owner

Type: docs · Risk: low · Tested on: none (docs only) · Needs: none

Why

The docs a player or contributor reads on the forge named the game by its title, or "OoT". The website already says "the game" (website/src/lib/public-copy.ts); these docs now say it too. No open issue fits (tracker searched).

What changed

docs/design.md and docs/development.md lose "(oot-recomp)" from their headings and the full title from their first lines, and "OoT" and "Ocarina of Time" in the prose of those two, docs/control.md and the README now say "the game". Names in code are unchanged.

  • docs: docs/design.md: the heading, the first line, and "OoT" in sections 2 to 7. Section 5's heading changes, so its anchor does too; nothing links to it.
  • docs: docs/development.md: the heading, the first lines (no more "the maintainer's repository folder stays oot-recomp"), and five rows of the switch tables.
  • docs: docs/control.md: "OoT" in the prose and the "(OoT)" labels of teleport and age. The protocol's oot event, --events oot and the oot_state_tap.c name stay: renaming them would break scripts.
  • docs: README.md: the write-back paragraph, the Orchid credit, and the example folders ~/Games/Zelda and ~/Games/Zelda-Café (now ~/Games/Longshot, ~/Games/Longshot-Café). The trademark notice stays.

Measurements

Nothing to measure: docs only.

Flags and settings

None

Testing

Tested: read each changed line; no check under tests/ or website/tests/ reads the changed text (searched). tests/run_all.py is left to CI (no checks are run on this PC).

Not tested: the website build with these pages; CI covers it.

Must be tested: None

Risks

What could break: a link to docs/design.md's old section 5 anchor (none in the repository).

Turning it off: revert the commit

Compatibility: Nothing changes

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). (CI runs it on @ f0b86b34)
  • 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.
  • Docs updated.

🤖 Generated with Claude Code

**Type:** docs · **Risk:** low · **Tested on:** none (docs only) · **Needs:** none ## Why The docs a player or contributor reads on the forge named the game by its title, or "OoT". The website already says "the game" (`website/src/lib/public-copy.ts`); these docs now say it too. No open issue fits (tracker searched). ## What changed `docs/design.md` and `docs/development.md` lose "(oot-recomp)" from their headings and the full title from their first lines, and "OoT" and "Ocarina of Time" in the prose of those two, `docs/control.md` and the README now say "the game". Names in code are unchanged. - docs: `docs/design.md`: the heading, the first line, and "OoT" in sections 2 to 7. Section 5's heading changes, so its anchor does too; nothing links to it. - docs: `docs/development.md`: the heading, the first lines (no more "the maintainer's repository folder stays `oot-recomp`"), and five rows of the switch tables. - docs: `docs/control.md`: "OoT" in the prose and the "(OoT)" labels of `teleport` and `age`. The protocol's `oot` event, `--events oot` and the `oot_state_tap.c` name stay: renaming them would break scripts. - docs: `README.md`: the write-back paragraph, the Orchid credit, and the example folders `~/Games/Zelda` and `~/Games/Zelda-Café` (now `~/Games/Longshot`, `~/Games/Longshot-Café`). The trademark notice stays. ## Measurements Nothing to measure: docs only. ### Flags and settings None ## Testing **Tested:** read each changed line; no check under `tests/` or `website/tests/` reads the changed text (searched). `tests/run_all.py` is left to CI (no checks are run on this PC). **Not tested:** the website build with these pages; CI covers it. **Must be tested:** None ## Risks **What could break:** a link to `docs/design.md`'s old section 5 anchor (none in the repository). **Turning it off:** revert the commit **Compatibility:** Nothing changes ## 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). (CI runs it on @ f0b86b34) - [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. - [x] Docs updated. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
docs: the game, not its title or OoT
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 4s
CI / Workflow lint (actionlint) (pull_request) Successful in 14s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 18s
Third-party parts / As their notes say (pull_request) Successful in 28s
PR description / Description follows the template (pull_request_target) Failing after 14s
f0b86b34aa
Co-Authored-By: Claude Opus 5.5 <[email protected]>
HumanBean changed title from WIP: docs: the game, not its title or OoT to docs: the game, not its title or OoT 2026-11-15 06:37:02 +00:00
HumanBean deleted branch docs/the-game-not-its-title 2026-11-15 06:37:08 +00:00
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!723
No description provided.