docs: catch up engine + visuals docs to v7.0.0-alpha.8 (#227 closure, TapeSnapshot home)#229
Merged
Merged
Conversation
… TapeSnapshot home) Engine README: - Add TapeSnapshot type + tapeViewport helper to the Tape section - Versioning notes section catches up alpha.5/6/7/8 (was at alpha.4); v7 milestone marked feature-complete with #102 Engine CLAUDE.md: - visuals package bullet: TapeSnapshot listed as re-exported from engine (not native); version mentions updated to 7.0.0-alpha.8 Visuals README: - TapeSnapshot type def line annotated 're-exported from @turing-machine-js/machine (alpha.8+); canonical home is engine'
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
Cross-repo docs audit found the engine README, engine CLAUDE.md, and visuals README all behind on the v7.0.0-alpha.8 surface (#227 —
TapeSnapshot+tapeViewportmoved to engine, PR #228). Catching them up.Changes
packages/machine/README.mdTapeSnapshot+tapeViewportblock inside §Tape, with example usage and a note that the canonical home is the engine package (visuals re-exports for back-compat).CLAUDE.mdTapeSnapshotlisted as re-exported from engine (was incorrectly listed as native to visuals) — cites Consider movingTapeSnapshot+tapeViewportto the engine; letTape.viewportuse the pure helper internally #227.Engine + libs at 7.0.0-alpha.6; visuals at 7.0.0-alpha.6.1→Engine + libs at 7.0.0-alpha.8; visuals at 7.0.0-alpha.8.packages/visuals/README.mdTapeSnapshottype def line annotated: "re-exported from@turing-machine-js/machine(alpha.8+); canonical home is the engine package, next to theTapeclass".Out of scope
machines/CLAUDE.mdupdates — deferred until engine alpha.8 is published to npm and post alpha.7 (PR #106) ships, so the umbrella catches both at once.Test plan
npm test— 664/664 pass (no source changes; docs only)