Repository navigation
docs(api): tighten prose across handbook version trees - #176
Merged
Merged
Conversation
Style-only pass over the 15 v2001.0.0 handbook pages that the latest tree now maps to. Replaces em dashes and mid-sentence colons in prose, converts bold-label lists to sentences, and cuts filler and AI vocabulary. Code blocks, numbers, links and VersionLink markup are unchanged.
Rewrite handbook pages in every version tree (v1.0.0, v1000.x, v2000.0.0, v2001.0.0) to remove AI writing patterns: em dashes, mid-sentence colons, bold labels, filler and hedging. Each hunk was checked for meaning changes against the matching source tag. Claims that changed were restored, and the trackingOnly names were updated to isTrackingOnly and recordEffectRead in the v2000.0.0 and v2001.0.0 architecture and performance pages.
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.
Summary
Prose pass over every handbook version tree:
v1.0.0,v1000.0.0,v1000.1.1,v1000.2.5,v1000.3.3,v2000.0.0andv2001.0.0, including the/latestglob source. Em dashes, mid-sentence colons, bold-label lists, filler, hedging and AI vocabulary are removed. Code blocks, numbers, links, frontmatter andVersionLinkmarkup are unchanged.Each changed hunk was checked for meaning changes. Claims that code backs were checked against the matching source tag (
1.0.0,1000.x.y,2000.0.0,2001.0.0). Where a rewrite changed a claim, the original claim was restored.Replaces #175, which covered only
v2001.0.0.Verification
npm run build(root): exit 0npm run lint(root): exit 0npm run check(root): exit 0npm run check(handbook):COMPLETED 374 FILES 0 ERRORS 0 WARNINGS 0 FILES_WITH_PROBLEMSThe handbook
vite buildwas not run for this PR.Source-backed corrections
architectureandperformancepages inv2000.0.0andv2001.0.0:trackingOnly/trackRead/registerEffectReadrenamed toisTrackingOnly/recordEffectRead(silentflag). Verified in tag2000.0.0andtrunksrc/index.ts.v1000.3.3architecture: batch error path clears both pending and deferred effects, as in tag1000.3.3executeBatch.Open items (not in this PR)
v1000.3.3says "about 489" lines (architecture) and "about 480" (introduction). Tag1000.3.3has 482 lines.v1000.3.3lens: "silently rejected" describes the proto-key denylist. In source, a rejected path becomes[], and an empty path makes the lens write the whole source object. The docs do not say so.v1000.0.0andv1000.2.5batch"Error handling" says only pending effects are cleared. Source also clears deferred effects.v2001.0.0(carried from the first pass):deriveandmigrationpages still have em dashes in new upstream text;handbook/src/lib/navigation.tslinks to/selectand/lens, which do not exist underv2001.0.0;installationsays "There are no subpath exports" whilepackage.jsondeclares./hooks; benchmark figures onstateandperformancedisagree.architecture:65(v2000.0.0andv2001.0.0): the flag isisTrackingOnlyin source. This PR updates the wording only.