Repository navigation
Writing style: short, plain README and website text - #17
Merged
Merged
Conversation
…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>
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'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
<!-- latest -->lines are unchanged, byte for byte.data-release*hook, download button and component is unchanged. The layout is the same.docs, not the oldsitefolder.Facts corrected (checked against
source/)blob/main/docs/DEVELOPMENT.md. The file moved to the repo root in 86e8762, so they now link toblob/main/DEVELOPMENT.md.AllocationPlangives "Wait for incoming deliveries to finish before lowering their limits.").OFL-Alegreya.txt).Checks
node tests/test-site.mjs: 76/76node --checkon everydocs/assets/*.js: cleancapsite.py) of every page at 1440px and 390px, light and dark: overflow 0Not played in game. Text only.
🤖 Generated with Claude Code