Skip to content

docs: add README for common, runner and web CSE machine packages#44

Merged
Akshay-2007-1 merged 3 commits into
mainfrom
docs/cse-machine-readmes
Jun 27, 2026
Merged

docs: add README for common, runner and web CSE machine packages#44
Akshay-2007-1 merged 3 commits into
mainfrom
docs/cse-machine-readmes

Conversation

@Akshay-2007-1

Copy link
Copy Markdown
Contributor

Summary

Adds a README.md for each of the three CSE machine packages, following the same structure as the data-display READMEs in #38.

  • src/common/cse-machine/README.md — protocol overview, constants table, and field-by-field documentation for all shared types (CseSnapshot, CseSerializedValue, CseSerializedInstruction, CseSerializedEnvFrame, CseSerializedBinding)
  • src/runner/cse-machine/README.mdCseMachinePlugin API reference and usage example showing how an evaluator serializes steps and calls sendSnapshots
  • src/web/cse-machine/README.mdCseMachineHostPlugin API reference, usage example showing how to extend it, and local dev serving instructions

Test plan

  • READMEs render correctly on GitHub
  • Cross-package links resolve correctly
  • No existing source files modified

@changeset-bot

changeset-bot Bot commented Jun 27, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 0a33205

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "@sourceacademy/web-stepper" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces comprehensive README documentation for the common, runner, and web packages of the CSE Machine visualizer, detailing their features, installation, structure, and usage. The review feedback suggests updating the documentation tables for CseSerializedValue and CseSerializedInstruction to explicitly mark the metadata fields as optional (unknown | undefined) to maintain consistency with the TypeScript definitions.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread src/common/cse-machine/README.md Outdated
Comment thread src/common/cse-machine/README.md Outdated
@Akshay-2007-1

Copy link
Copy Markdown
Contributor Author

@AaravMalani I am merging this for now as its easy to fix if there are issues.
I have taken inspiration from the READMEs of the data vis plugin after reviewing your PR.

@Akshay-2007-1 Akshay-2007-1 merged commit c70cec3 into main Jun 27, 2026
1 check passed
@Akshay-2007-1 Akshay-2007-1 deleted the docs/cse-machine-readmes branch June 27, 2026 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant