docs: document checkpoint artifact integrity during resume#224
Draft
cursor[bot] wants to merge 1 commit intomainfrom
Draft
docs: document checkpoint artifact integrity during resume#224cursor[bot] wants to merge 1 commit intomainfrom
cursor[bot] wants to merge 1 commit intomainfrom
Conversation
Co-authored-by: Sara Loera <saraeloop@users.noreply.github.com>
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.
🧠 Noēsis Pull Request
Overview
Documentation-only update clarifying the checkpoint/resume integrity contract so developers can diagnose
CheckpointConsistencyErrorreliably during pause/resume workflows.Type of Change
Motivation & Context
Recent lifecycle hardening in checkpoint/resume validation added strict artifact-manifest consistency checks anchored to checkpoint evidence. Existing docs mentioned anchor/state checks but did not fully explain artifact drift behavior (especially manifest appearance/disappearance while paused), creating troubleshooting ambiguity.
Technical Details
Docs added/updated
docs/reference/python-api.mdxartifact_manifest_hashvalidation.event_offset.CheckpointConsistencyErrordescription with full anchor fields.docs/guides/integrate-adapters.mdxCheckpointConsistencyErrorwithartifact manifest hash.manifest.json; lifecycle appends are expected and safe).Codepaths covered
noesis/usecases/run_lifecycle.py_assert_checkpoint_consistency(...)_artifact_digest(...)_events_prefix_artifact(...)tests/runtime/test_run_lifecycle.pyKey knowledge gaps addressed
Validation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)ADR-003 Schema Governance Checklist
$schema_versionbumped for every artifact whose stable fields changeddocs/schema/**regenerated (no diff afterpython scripts/gen_schema.py)internal_docs/schema/kpi*.yamlMIGRATIONS.schema.mdorMIGRATIONS.kpi.mdpython scripts/schema_guard.py --strict --jsonpasses locallydocs/app/reference/*updated when new fields/KPIs surface to usersObservability & Safety
No runtime behavior changed in this PR. The docs now explicitly communicate existing integrity guardrails and likely failure modes, reducing unsafe manual artifact mutations during paused runs.
Educational / Research Value
Screenshots / Logs
N/A.
Related Issues / References
noesis/usecases/run_lifecycle.pycheckpoint/resume integrity checkstests/runtime/test_run_lifecycle.pylifecycle consistency regression coverage