docs: clarify human approval lifecycle - #228
Draft
cursor[bot] wants to merge 1 commit into
Draft
cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
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
Updates the human-in-the-loop documentation to reflect the verified unsealed-run lifecycle for approvals and checkpoint/resume behavior. Also expands the Python API run lifecycle reference with checkpoint artifact integrity details.
Type of Change
Motivation & Context
The previous human approval guide showed interrupting/checkpointing after
ns.solve(...)returned, which does not match sealed terminal run behavior. These docs now explain where approval gates must sit, how paused runs expose checkpoint evidence, and how prepared tool approvals bind to durable draft identity.Technical Details
Docs added/updated:
docs/guides/human-in-the-loop.mdx: rewritten as a concise operational runbook for human approval workflows.docs/reference/python-api.mdx: documents checkpoint metadata andartifact_manifest_hashbehavior.Codepaths covered:
ns.interrupt(...),ns.checkpoint(...),ns.resume(...),ns.resume_run(...)run.interrupt -> run.checkpoint)ToolApprovalDecisionstate.json, and manifest/artifact digestingKey knowledge gaps addressed:
RunSealedErrorresumeemits evidence only whileresume_runcontinues executionevents.jsonlprefixValidation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)Validation performed:
python3 -c ...import smoke for documented approval symbols passed.python3 -c ...pause-on-veto lifecycle smoke passed, verifyingrun.interrupt,run.checkpoint, skipped side effect, and absent terminal artifacts.uv run pytest ...could not run becauseuvis not installed in the runner.python3 -m pytest ...could not run becausepytestis not installed in the runner.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 usersNo schema or artifact field changes; documentation only.
Observability & Safety
Improves operator guidance for approval gates, paused run inspection, checkpoint integrity failures, and prepared tool approval binding.
Educational / Research Value
Clarifies how Noēsis preserves auditable same-run continuity for human-reviewed actions.
Screenshots / Logs
Related Issues / References
noesis/usecases/run_lifecycle.pynoesis/usecases/tool_invocation/runtime_bridge.pytests/runtime/test_run_lifecycle.pytests/runtime/test_tool_invocation_runtime_bridge.py