Skip to content

Writing style: short, plain README and website text - #17

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

Kyler's new rule for every timbermods repo: "simplicity and elegance is effective and desirable." This PR applies it to the README, the website (docs/) and the FAQ and troubleshooting pages. It also adds the rules to CLAUDE.md.

What changed

  • README: 1,843 → 1,260 words (123 → 122 lines; the old lines were very long). It is written for a player: install, set up, controls, good to know, multiplayer, trouble, removing, status, license. The three <!-- latest --> lines are unchanged, byte for byte.
  • Site text: shorter sentences, each thing said once, and no internals or history. Every id, data-release* hook, download button and component is unchanged. The layout is the same.
  • Status: now one statement, word for word the same in the README's Compatibility and testing and the site's What's been played note. Its meaning is unchanged: the layout and visuals have been checked in game, and the newer behavior (Copy settings, store nothing, the Apply ring, Supply mode, damaged saves, messages) hasn't been played.
  • Removed: the FAQ's replay-recordings question, which is history about the old add-on.
  • CLAUDE.md: adds a Writing README and website text section. The content rules and the release checklist now point to it. The preview and detector commands now use docs, not the old site folder.
  • PRODUCT.md: the voice line points to those rules.

Facts corrected (checked against source/)

  • Developer notes links: the footer on all five pages and the FAQ linked to blob/main/docs/DEVELOPMENT.md. The file moved to the repo root in 86e8762, so they now link to blob/main/DEVELOPMENT.md.
  • Lower limits during deliveries: the home page said a lower limit that clashes with incoming deliveries "waits until they arrive". Apply actually refuses it (AllocationPlan gives "Wait for incoming deliveries to finish before lowering their limits.").
  • No-JavaScript note: it said the screenshot is "at the top of this page". The screenshot is in the section above the demo.
  • Demo tip: it said "Paste" and "the other building". The button is Paste allocations, and the demo has three buildings.
  • README fonts: the license line named only Noto Sans. Alegreya SC is self-hosted too (OFL-Alegreya.txt).
  • README unofficial line: it was missing and has been added.

Checks

  • node tests/test-site.mjs: 76/76
  • node --check on every docs/assets/*.js: clean
  • Local links and anchors: all resolve
  • Captures (capsite.py) of every page at 1440px and 390px, light and dark: overflow 0

Not played in game. Text only.

🤖 Generated with Claude Code

…ecked against the code

Kyler: "simplicity and elegance is effective and desirable." The README (1,843 to 1,260 words) and the site's
text say each thing once, lead with the action, drop internals and history, and describe the mod as it is now.
The status is one short statement, word for word the same in the README and the site.

Corrections: the site's "Developer notes" links pointed at docs/DEVELOPMENT.md, which moved to the repo root;
the home page said a lower limit that clashes with deliveries "waits until they arrive" (Apply refuses it); the
no-JavaScript note pointed at a screenshot "at the top of this page"; the demo tip said "Paste" and "the other
building" (the button is Paste allocations, and there are three buildings); the README license line named only
Noto Sans among the self-hosted fonts (Alegreya SC is there too) and lacked the unofficial line.

The FAQ's old replay-recordings question (history of the former add-on) is gone. CLAUDE.md gains the
"Writing README and website text" rules, and its preview and detector commands point at docs/, not site/.
PRODUCT.md's voice line points at the rules. The look is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kramsey458
kramsey458 merged commit 203791d 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