Skip to content

docs: fix save-file manager description (drift from the #89 UI refactor)#96

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/docs-accuracy-sweep
Jun 13, 2026
Merged

docs: fix save-file manager description (drift from the #89 UI refactor)#96
dmccoystephenson merged 1 commit into
mainfrom
feature/docs-accuracy-sweep

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

A documentation-accuracy sweep (Stage A) of the whole repo against source. One real drift found and fixed:

  • README "Multiple Save Files" claimed the manager shows each save's "Last Modified" time. Since the save manager was routed through the UI (Route the save-file manager through the UI (closes #42) #89), each slot is shown as a menu option labelled Load Slot N (Day X, $Y, Z fish) — no last-modified timestamp. Updated the section to match (Day, Money, Fish count; slots chosen as options).

Swept and verified accurate (no change needed)

  • README: web-interface instructions (examples/web_app.py, port 8000, stdlib-only), the $10,000 goal, the fishing-business description, and the trunk-based Contributing section.
  • install.sh / run.sh: repo URL and run command match.
  • Schemas: all persisted fields in playerJsonReaderWriter / statsJsonReaderWriter / timeServiceJsonReaderWriter are present in their schemas/*.json (checked programmatically — zero writer-keys missing from schema).

Test plan

  • SDL_VIDEODRIVER=dummy SDL_AUDIODRIVER=dummy python3 -m pytest — 211 passed (docs-only change; no code touched)

Triage note

🤖 Generated with Claude Code

The README said the save-file manager shows each save's "Last Modified" time,
but since the manager was routed through the UI (#89) each slot is presented as
a compact menu option labelled "Load Slot N (Day X, $Y, Z fish)" — it no longer
displays a last-modified timestamp. A reader comparing the docs to the actual
screen would be misled.

Updates the Multiple Save Files section to match what the manager actually shows
(Day, Money, Fish count) and reflects that slots are chosen as menu options.
The rest of the docs were swept against source as part of this pass: README
features, the branching/Contributing section, and all four schemas (verified
in sync with their reader/writers) are accurate.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@dmccoystephenson dmccoystephenson left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review:

  • Scope: PASS — README only; the rest of the sweep found no drift (schemas verified in sync with writers programmatically; web/goal/business/Contributing accurate).
  • Docs: PASS — 'Last Modified' removed to match the #89 menu (Day/Money/Fish).
  • CI: PASS — docs-only, 211 tests still green. No code/schema touched.

@dmccoystephenson dmccoystephenson merged commit 729689c into main Jun 13, 2026
1 check passed
@dmccoystephenson dmccoystephenson deleted the feature/docs-accuracy-sweep branch June 13, 2026 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant