docs: staleness pass after this session's engine and UX fixes#37
Merged
Conversation
Audited all four docs (README, CLAUDE.md, CONCEPTS.md, ROADMAP) plus the in-app knowledge base against current code and fixed 14 discrepancies. README: - "Examples menu" corrected to "Library" (no Examples menu exists) - dependency claim scoped: math.js is the only runtime CODE dep; Font Awesome is also vendored - architecture table now names js/kb.js and the app-*.js prototype-mixin split instead of implying app.js is monolithic - added the missing Trader node to the Nodes list and the intro - testing section notes CI now runs both suites on push/PR CLAUDE.md: - documented that CI exists (npm install not npm ci, since the lockfile is gitignored; test/export.js is manual-run, not in CI) - documented the two new engine invariants: synchronous snapshot-based conditions (_tickSnap/_condValueOf) and reproducible/checkpointable RNG (SimRandom getState/setState) CONCEPTS.md: - resolved the internal contradiction the new "Conditions are synchronous" subsection created: SS8's one-step-lag paragraph over-generalized. Rate formulas and variable-based conditions still lag; source-value conditions read the tick-start snapshot. Now stated precisely with a cross-reference. - SS7 tick list now includes the order-sensitive _applyPushProposals phase ROADMAP: - test bullet notes automatic CI; checkpoint snapshot list now includes RNG position; corrected a drifted renderer.js line reference In-app KB (js/kb.js): - "saving" article no longer describes a nonexistent restore banner (autosave restores silently and unconditionally) - "sharing" article names the real menu item "Copy share link", not "Share" - de-en-dashed a user-facing string Verification: 197 unit tests green, smoke test green (loads the edited KB). Co-Authored-By: Claude Fable 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
1 participant
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.
A full documentation audit: five parallel auditors checked README, CLAUDE.md, docs/CONCEPTS.md, ROADMAP.md, and the in-app knowledge base (js/kb.js + help/welcome text) against the current code, and every high-impact finding was independently cross-checked before applying. 14 discrepancies fixed.
The one that mattered most
This session's PR#36 added a "Conditions are synchronous" subsection to CONCEPTS.md but left §8's older "one-step lag" paragraph claiming conditions read the previous step's value. That was now false for source-value conditions (they read the tick-start snapshot via
_condValueOf). Fixed precisely: rate formulas and variable-based conditions still lag; source-value conditions use the tick-start snapshot. Verified against engine.js:1259-1261.Everything else
js/kb.jsand theapp-*.jsmixin split instead of a monolithic app.js; added the missing Trader node; testing section notes CInpm installnotnpm ci), plus the two new engine invariants agents should preserve (synchronous conditions, reproducible/checkpointable RNG)_applyPushProposalsphase to the §7 tick listrenderer.jsline referenceNo false claims were left as-is; a few
imprecise/nititems were applied too since they were cheap and correct. Docs-only except js/kb.js (in-app copy), which the smoke test exercises.Verification
197 unit tests green, smoke test green (loads the edited knowledge base).