docs: clarify run checkpoint/resume integrity contracts#225
Draft
cursor[bot] wants to merge 1 commit intomainfrom
Draft
docs: clarify run checkpoint/resume integrity contracts#225cursor[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
Refresh lifecycle documentation for checkpoint/resume behavior so operators can reliably troubleshoot paused runs and fail-closed resume errors.
Type of Change
Motivation & Context
Recent runtime changes enforce stronger checkpoint consistency checks (event anchor, state hash, artifact digest, resume anchor constraints). Existing docs mentioned these only at a high level, leaving operators without concrete payload/runbook guidance when resume fails.
Technical Details
Updated docs in-place (no new redundant pages):
docs/reference/events.mdxrun.interrupt,run.checkpoint, andrun.resumeruntime events.caused_byanchor requirement for resume events.docs/reference/python-api.mdxCheckpointConsistencyErrorbreakdown, including artifact-manifest drift and invalid explicit resume anchors.docs/guides/human-in-the-loop.mdxValidation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)Notes:
tests/runtime/test_run_lifecycle.py) while authoring docs.python scripts/validate_exports.py --strict; current repo baseline reports missingdocs/app/referenceexports unrelated to this docs change.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. This PR reduces operational risk by documenting fail-closed resume conditions and expected runtime evidence.
Educational / Research Value
Screenshots / Logs
Not applicable.
Related Issues / References
noesis/usecases/run_lifecycle.pynoesis/core.pytests/runtime/test_run_lifecycle.py