docs: add README for common, runner and web CSE machine packages#44
Conversation
|
There was a problem hiding this comment.
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.
|
@AaravMalani I am merging this for now as its easy to fix if there are issues. |
Summary
Adds a
README.mdfor 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.md—CseMachinePluginAPI reference and usage example showing how an evaluator serializes steps and callssendSnapshotssrc/web/cse-machine/README.md—CseMachineHostPluginAPI reference, usage example showing how to extend it, and local dev serving instructionsTest plan