Repository navigation
Writing style: README, website and settings doc short and plain - #14
Merged
Merged
Conversation
…players - README (183 -> 128 lines): what it changes, install, check, settings, co-op, what to do when something goes wrong, the played status and the measured table. Internals and version history left to DESIGN.md, TESTING.md and CHANGELOG.md; build steps moved to TESTING.md. - Site: shorter sentences, each thing said once (saves, co-op recovery, "only the timing moves"), no internals, no history. The install guide's sample Day line is labelled as made-up numbers (it said it came from the test colony). "Not yet played" names the current release. og.png re-captured for the new hero lede. - CONFIGURATION.md: shorter meanings, edge-case detail cut; defaults checked against Config.cs. - CLAUDE.md: the "Writing README and website text" rules; PRODUCT.md voice line points at them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies the new timbermods writing style ("simplicity and elegance is effective and desirable") to the player-facing text. The mod's behavior is unchanged.
README (183 → 128 lines). It now covers what the mod changes, install, checking that it works, settings, co-op, what to do when something goes wrong, the played status and the measured table. The internals (determinism, components, path-cost scaling, performance), the version history and the full 33-day numbers are gone: DESIGN.md, TESTING.md and CHANGELOG.md already hold them, and the README links there. The build steps moved to a new Building section in TESTING.md. The README also gains the unofficial/Mechanistry line.
Site (index, install, troubleshooting, FAQ). Shorter sentences. Each thing is said once:
#switched-off, now numbered steps. Install and the FAQ link to them.No internals or history are left. All ids,
data-release*hooks andrelease.jsare unchanged.og.pngis re-captured because the hero lede changed, and its provenance is embedded again (scan: 5 rasters, 0 missing).CONFIGURATION.md: the meanings are shorter and the edge-case detail is cut. Every default was checked against
Config.cs.CLAUDE.md gets the Writing README and website text section. The content rules and the release checklist point to it. PRODUCT.md's voice line gets the short-and-plain sentence.
Facts corrected:
Day 319line was "an example from the test colony". Its numbers are illustrative: PRODUCT.md says so, and the test colony did no building while the line shows 60 builder job checks. It now says "made-up numbers".Checks:
node tests/test-site.mjs37/37, planner checks pass,node --check docs/assets/shift.jspasses, and local links resolve. Captures at desktop and 390px, light and dark, show overflow 0.Not played: this is a text-only change.
🤖 Generated with Claude Code