Skip to content

README and site: short and plain, for players - #18

Merged
kramsey458 merged 1 commit into
mainfrom
claude/writing-style
Sep 24, 2026
Merged

kramsey458 merged 1 commit into
mainfrom
claude/writing-style

Conversation

@kramsey458

Copy link
Copy Markdown
Collaborator

A writing pass over the README and the four site pages. They now follow the style adopted for Timber Together: written for players, one idea per sentence, on-screen labels exactly as in game, each thing said once, and no internals or history. Every fact was checked against the code and enUS_PersistentWorkAreas.csv.

Corrected

  • README status: one line said the 1.1.0 features "have not been playtested in game yet", and another said they had been played extensively. The README and site now say "played extensively" once, in the Status lists, and those lists match word for word. No code has changed since v1.1.0, so nothing is marked unplayed.
  • FAQ "How do I pin": the "full steps" link went to How it works, which has no steps. The answer is now complete without it.
  • Co-op desync advice: the old advice was to disable the mod "on the affected computer", which is the unplayed one-computer setup. It now says to disable it on every computer.

Shorter

  • README: 85 → 77 lines and 1224 → 703 words. It covers install, pinning, planting tools, clearing, remembered pins, co-op, limits, status and license. It also gains the unofficial line.
  • New in 1.1.0 and Earlier versions are gone from the README. The release notes already carry them, and the README links there.
  • Build from source and the internals from Compatibility and validation moved to a new DEVELOPING.md.
  • Site: shorter text throughout. Troubleshooting fixes are now numbered steps, and duplicated co-op and status text is replaced by links. The FAQ build answer points to DEVELOPING.md. The layout, ids, anchors and data-* hooks are unchanged.
  • CLAUDE.md: a new Writing README and website text section, with the content rules and release checklist pointing to it.
  • PRODUCT.md: the voice line gains the new rule. Its version-history pointer now names the release notes.

Checks: dotnet run --project tests/Checks.csproj -c Release gives 77 passed and 65 skipped. node --check passes on site.js and demo.js. All local links and anchors resolve, and tags are balanced. Captured every page at desktop and 390px in light and dark, with overflow 0 everywhere.

🤖 Generated with Claude Code

The README (85 -> 77 lines, 1224 -> 703 words) and the four site pages rewritten in the new
writing style: one idea per sentence, labels exactly as in game, each thing said once, no
internals and no history. Every fact checked against the code and the localization CSV.

- README: the contradictory "features new in 1.1.0 have not been playtested" line is gone.
  "Played extensively" is said once, in a Status section that matches the site's word for word.
  "New in 1.1.0" / "Earlier versions" are dropped (the release notes carry them; the README
  links there). Build, checks and how it works moved to a new DEVELOPING.md.
- Site: shorter answers, troubleshooting fixes as numbered steps, the FAQ build answer links
  to DEVELOPING.md, and the hero status note links to the status section instead of repeating it.
- CLAUDE.md: new "Writing README and website text" section; content rules and the release
  checklist point at it. PRODUCT.md: the voice line, and version history now lives in the
  release notes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kramsey458
kramsey458 merged commit f6ce05d into main Sep 24, 2026
1 check passed
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