docs: add lifecycle resume integrity troubleshooting runbooks#222
Draft
cursor[bot] wants to merge 1 commit intomainfrom
Draft
docs: add lifecycle resume integrity troubleshooting runbooks#222cursor[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
Strengthens lifecycle documentation for paused/approved runs by adding explicit resume integrity troubleshooting runbooks to existing docs pages.
Type of Change
Motivation & Context
Recent lifecycle changes enforce stronger checkpoint consistency (
event_offset, causal anchors,state_hash, artifact digest/manifest hash). Existing docs listed the errors but lacked a practical operator runbook for diagnosing resume failures.Technical Details
Updated existing documentation (no new pages):
docs/reference/python-api.mdxCheckpointConsistencyErrorto includeartifact_manifest_hashResume integrity runbooksection covering:final.json)events.jsonl,state.json, optionalmanifest.json)caused_byconstraintsdocs/guides/human-in-the-loop.mdxResume troubleshooting runbookfor approval workflowsRunSealedError,CheckpointNotFoundError,CheckpointConsistencyError, andResumeAdapterMismatchErrorValidation
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
Docs now explicitly describe fail-closed lifecycle behavior at resume boundaries, reducing operational ambiguity and unsafe retries against drifted/sealed artifacts.
Educational / Research Value
Clarifies the practical implications of lifecycle invariants for teams building approval-gated and human-in-the-loop workflows.
Screenshots / Logs
n/a (docs-only)
Related Issues / References
noesis/usecases/run_lifecycle.pytests/runtime/test_run_lifecycle.py