docs: align HITL resume, sealing, and layout with runtime contracts - #241
Draft
cursor[bot] wants to merge 4 commits into
Draft
cursor[bot] wants to merge 4 commits into
cursor[bot] wants to merge 4 commits into
Conversation
Replace the post-solve interrupt and follow-up ns.run approval patterns with the unsealed pause-on-veto + resume_run contract, including artifact_manifest_hash resume failures. Co-authored-by: Sara Loera <sara@saraeloop.com>
Remove nested label directories and ns.set(label=...) guidance. Record the final.json-before-manifest seal, .noesis/index retention, and ULID episode IDs. Co-authored-by: Sara Loera <sara@saraeloop.com>
Clarify that planner_mode does not enable PreActGovernor, ns.get() is the config accessor, runs_dir must sit under .noesis, and noesis run has no --intuition flag. Add the missing llms-txt reference page. Co-authored-by: Sara Loera <sara@saraeloop.com>
Pause-on-veto still calls ensure_learn_file before returning the unsealed episode. Co-authored-by: Sara Loera <sara@saraeloop.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
Align published docs with the current runtime contracts for human-in-the-loop continuation, artifact layout/sealing, planner vs governance config, and
runs_dirresolution. This is documentation-only.Type of Change
Motivation & Context
Several how-to and explanation pages still described behavior that the runtime rejects:
ns.solve/ started a newns.runafter approval.label/dirs andns.set(label=...)/ns.set(seed=...)/log_prompts(not config keys).planner_mode="minimal"as "skip governance" and calledns.config().NOESIS_RUNS_DIR=/srv/noesis/episodes, which resolves to{runs_dir}/.noesis/episodes.CheckpointConsistencyErrordocs omittedartifact_manifest_hash(checkpoint integrity from fix(lifecycle): enforce checkpoint artifact integrity during resume #210).docs.jsonalready linkedreference/llms-txtbut the page was missing.Docs added/updated
Updated
docs/guides/human-in-the-loop.mdx— pause-on-veto +ns.resume_runrunbookdocs/reference/python-api.mdx— lifecycle flow, checkpoint hash, EpisodeIndex pathdocs/reference/events.mdx—run.interrupt/run.checkpoint/run.resumepayloadsdocs/explanation/artifacts.mdx— flat layout,final.jsonseal, index, manifestfiles[]docs/explanation/core-concepts.mdx— ULID IDs, lifecycle states, nons.set(seed=)docs/explanation/prompt-provenance.mdx— path without label nestingdocs/index.mdx,docs/quickstart.mdx,docs/guides/adopting-noesis.mdx— matching layoutdocs/guides/configure-planner-modes.mdx—planner_modevsgovernance_mode,ns.get()docs/guides/configure-shared-storage.mdx—.noesisparent rule + migrate-layoutdocs/reference/configuration.mdx,docs/reference/cli.mdx—runs_dirpitfall, migrate-layout constraintsdocs/guides/write-policies.mdx,docs/tutorials/first-policy.mdx— shipped CLI has no--intuitionAdded
docs/reference/llms-txt.mdx— page already referenced fromdocs/docs.jsonCodepaths covered
noesis/usecases/episode_runner.pypause-on-veto (_pause_on_governance_veto)noesis/usecases/run_lifecycle.pycheckpoint anchors /_artifact_digest/_assert_checkpoint_consistencynoesis/core.py_seal_episode, non-terminal skip of_finalize_episode,resume_rungoal reuse,EpisodeIndex(layout.index_dir, ttl_days=30)noesis/runtime/paths.pyresolve_noesis_root/resolve_noesis_pathsnoesis/domain/config/settings.pyALLOWED_CONFIG_KEYSnoesis/infrastructure/layout_migration.py+noesis/cli/__main__.pymigrate-layoutnoesis/io.pylist_runs(skips dirs withoutsummary.json)tests/runtime/test_run_lifecycle.py,tests/runtime/test_sealing_flow.py,tests/runtime/test_episode_dir_layout.py,tests/governance/test_pre_act.pyKey knowledge gaps addressed
resume_rundoes not rewrite the goal;PreActGovernorcan veto again.artifact_manifest_hashfails ifmanifest.jsonappears or disappears after checkpoint.planner_modedoes not enable/disable governance (governance_modedoes; default isoff).ep_<ULID>/;final.jsonis the seal; index is.noesis/index/.runs_dirparent must be.noesis(or the path is.noesis).Technical Details
Documentation-only. No schema or runtime changes.
Validation
Required
uv run pytest) or equivalent targeted suite — docs-only; not re-runSituational
npx mintlify@latest broken-linksfromdocs/reported no broken linkspython scripts/pre_release.py --check-all) — N/AADR-003 Schema Governance Checklist
N/A — no schema/KPI changes.
Observability & Safety
No runtime or telemetry changes. Docs now match fail-closed sealing and checkpoint integrity behavior.
Related Issues / References
Follows merged runtime work in #210 (checkpoint artifact integrity) and #219 (direction/veto docs). Overlapping draft docs PRs #220–#240 cover some of the same ground and should not be merged as duplicates if this lands.