Improve tutorial and correct their claims - #22
Merged
Merged
Conversation
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
All reported issues were addressed across 8 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
The pages workflow deploys wasm/ to gh-pages, so the tutorial now has a URL worth linking. README leads Getting Started with it, since it needs no toolchain, and the four paragraphs that restated the example session became comments inside the session itself, which now pastes into "make run" verbatim. wasm/index.html gains the overview it was missing: one paragraph on MUXLEQ as a machine, one on eForth as what makes it usable, and a link to docs/manual.md from both the intro and the last chapter. The page used to call MUXLEQ a one-instruction computer in the intro and 2-instruction machine in the chapter titled "Underneath: two instructions".
jserv
force-pushed
the
docs-tutorial-polish
branch
from
August 5, 2026 07:20
1eab8b5 to
7a94e61
Compare
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.
The pages workflow deploys wasm/ to gh-pages, so the tutorial now has a URL worth linking. README leads Getting Started with it, since it needs no toolchain, and the four paragraphs that restated the example session became comments inside the session itself, which now pastes into "make run" verbatim.
wasm/index.html gains the overview it was missing: one paragraph on MUXLEQ as a machine, one on eForth as what makes it usable, and a link to docs/manual.md from both the intro and the last chapter. The page used to call MUXLEQ a one-instruction computer in the intro and 2-instruction machine in the chapter titled "Underneath: two instructions".
Summary by cubic
Publishes and polishes the eForth-on-MUXLEQ web tutorial, makes it the primary Getting Started path, and fixes conflicting machine claims by documenting the two instruction forms and the reserved right-shift escape with links to the reference manual.
New Features
wasm/is deployed to GitHub Pages; README links to the live tutorial at https://sysprog21.github.io/muxleq/.wasm/index.htmlexplaining MUXLEQ (two instruction forms + shift escape) and eForth, with links todocs/manual.mdfrom the intro and the last chapter.make runverbatim; testing docs note fallbacks to prebuilt RV32I images.Bug Fixes
plotstack comment and usage;wasm/snake.fthand browser tests updated).Written for commit 7a94e61. Summary will update on new commits.