Repository navigation
Writing style: README, website and FAQ short and plain - #15
Merged
Merged
Conversation
Kyler, 2026-09-24: "simplicity and elegance is effective and desirable." The README, the four site pages and the FAQ are rewritten for a player: one idea per sentence, each thing said once, no internals and no history. Status, credits, the unofficial line and safety facts are kept. - README 197 -> 121 lines (changelog unchanged). Build and test, how a pass works inside, costs and budgets, saved-state sizes, determinism and the test list move to a new DEVELOPING.md. - Site: text changed inside the existing components only; every id, anchor and data-* hook is kept. Duplicates removed (install's second pass-line key, the FAQ's repeated conflict sentence, rules already stated in the features), internals dropped (budget numbers, remembered-cost ages, class names), troubleshooting answers turned into numbered steps. - Facts checked against the code: a paused workplace still counts (GameAdapter.JobOf), so "the workplace is disabled or in another district" is gone; the Iron Teeth answer loses "only handles beaver dwellers"; the home comparison note links the FAQ's "Is it the best?" and keeps the looser-bed-rules caveat. - CLAUDE.md gains "Writing README and website text", pointed at from the content rules and the release checklist; build references and the MixedStorage release.js path (now docs/assets/) are updated. PRODUCT.md's voice line gains the short-and-plain sentence. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
details.q summary is a two-column grid (text, then the 24px arrow). A summary that mixed text and <code> became several grid items, so the log text landed in the arrow's column, one character per line, on seven of the eleven symptoms (live on main too). Each such summary's content is wrapped in one <span>, like the plain-text summaries; no CSS change. 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.
Kyler, 2026-09-24: "simplicity and elegance is effective and desirable." This is the Timber Together writing pass applied here. The README, the site and the FAQ are rewritten for a player: one idea per sentence, each thing said once, no internals and no history.
What changed
<!-- latest -->line is kept.DEVELOPING.md: build and test commands, how a pass works inside, per-tick budgets and the large-colony figures, determinism, saved-state sizes, tuning constants and the test list. All of it moved from the README.index,install,troubleshooting,faq): text changed inside the existing components only. Every id, anchor,data-release*attribute andrelease.jsis unchanged (checked by diff).DEVELOPING.md.GameAdapter.JobOf), so "workplace is disabled or in another district" is gone.DEVELOPING.md.docs/assets/release.js;site/assets/404s).A separate fix (second commit)
details.q summaryis a two-column grid. On seven of the eleven troubleshooting symptoms, the summary mixed text and<code>. The log text fell into the 24px arrow column, one character per line, and this is live on main now. Each such summary's content is now wrapped in one<span>, with no CSS change.Checks
dotnet run --project OptimizedLocalHousing.Tests -c Release:40 checks passed.(no game install needed).node --checkonsite.js,seating.jsandrelease.js: OK.release.jsis unchanged, and its hash matches MixedStorage'sdocs/assets/release.js.capsite.pyfor all four pages at desktop and 390px, light and dark:overflow 0everywhere. I also checked troubleshooting and the FAQ with every answer open.Not played. Text and markup only; no mod code changed.
🤖 Generated with Claude Code