docs: align README and ledger schema with runtime behavior#44
Merged
WhatsYourWhy merged 1 commit intoFeb 22, 2026
Merged
Conversation
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
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.
Motivation
Description
README.mdto clarify determinism: the runtime guarantees semantic replay (same graph/state/config/seed → same state/artifact hashes and step records) rather than byte-for-byte identical ledger files because ledger records include timestamps and incidental metadata. The README minimal example was replaced with a runnable, API-accurate snippet usingGraph(graph_id, version, steps),StepResult, andStepEvent, and the import list was corrected. (files changed:README.md)docs/LEDGER_SCHEMA.mdexamples to match the code: state files are emitted as0000.json,0001.json, etc.;RunConfig.output_diris the configured output root;RUN_START.runcontains onlymodeandseed(no CLI-only fields);STEP_START.step_versionuses thesrc:<sha256(module_file_bytes)>format;graph_node_idvalues matchn{index:04d}; terminal record statuses useCOMPLETED. (file changed:docs/LEDGER_SCHEMA.md)RunResult.statusandRunResult.ledger_pathafter a run.Testing
python -m pytest -q, and all tests passed:13 passed.determinant.step.StepResult/StepEventanddeterminant.run.runbehavior observed during tests.COMPLETEDstatuses) by inspectingdeterminant/run.pyanddeterminant/ledger.pyduring the change.Codex Task