docs(machine): README refresh (TOC, tagline, version notes, fwd-ref glosses)#145
Merged
Conversation
…losses) Five changes: 1. Tagline rewrite — line 6 went from "Some basic objects..." to a feature-listing one-liner. The old text undersold and had a lowercase "turing". 2. Collapsible TOC under the tagline — top-level sections plus the key Classes / Special-objects subsections, so long-README nav isn't scroll-only. 3. Inline gloss expansion — the paragraph after Quick start now introduces ifOtherSymbol / haltState / movements / symbolCommands inline (with anchor links to §Special objects) instead of relying on the reader to find the definitions 400+ lines later. Targets the forward-reference pattern where the Quick start example uses sentinels the reader has no intro for. 4. Dropped stale "(v4+)" markers — line 312 example comment and the ## Debugging breakpoints heading. Also dropped the now-unused `type DebugConfig` from the import line in the same code block (it was imported but never used). The breakpoints anchor shifts from #debugging-breakpoints-v4 → #debugging-breakpoints; the sibling post-machine-js README has a cross-repo link to the old anchor and will need a coupled fix in its own README-refresh PR. 5. New ## Versioning notes section — between §Introspection and §Libraries — laying out v4/v5/v6 surface changes in past tense plus a link to the GitHub releases page. Replaces the scattered inline "(v4+)" qualifiers with one consolidated reference. Free bonus: "on the Wikipedia" → "on Wikipedia" in §Links.
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.
Summary
Engine README refresh, five focused changes:
Some basic objects to build your own turing machine→ a feature-listing one-liner. The old text undersold and had a lowercase "turing".ifOtherSymbol/haltState/movements/symbolCommandsinline with anchor links to §Special objects, instead of relying on the reader to find the definitions 400+ lines later.(v4+)markers — line 312 comment and the §Debugging breakpoints heading. Also dropped the now-unusedtype DebugConfigfrom the import line in the same code block.Free bonus:
on the Wikipedia→on Wikipediain §Links.Coupled change to track
Dropping
(v4+)from## Debugging breakpointsshifts its anchor from#debugging-breakpoints-v4→#debugging-breakpoints. The sibling repo'spost-machine-js/packages/machine/README.md(line 412) currently links to the old anchor — it will break on merge here and gets fixed in the upcoming post-machine README-refresh PR.Test plan
Doc-only. No engine code changed; tests / lint / build untouched.
(v4+)text in the file.DebugConfigimport dropped; the example code block doesn't use it.