docs: repair README and align layout, HITL resume, and process grouping - #239
Draft
cursor[bot] wants to merge 1 commit into
Draft
docs: repair README and align layout, HITL resume, and process grouping#239cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
Fix the landing README's broken verification/resume examples and stale docs/app links. Document the flat ep_<ULID> artifact layout, runs_dir resolver constraints, pause-on-veto + resume_run approval path, and add the missing llms-txt page plus tutorial nav entries. 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.
Overview
Repair the landing README and align public docs with the current episode layout, pause-on-veto approval path, and process grouping.
Type of Change
Motivation & Context
The README mixed verification and resume examples into broken fences and still linked to removed
docs/app/...paths. Several explanation pages still described nestedlabel/episode directories andns.set(label=...)/ns.set(log_prompts=True), which are not config keys. HITL Slack/Gradio/async examples started a new episode after approval, which cannot continue a sealed run.Docs added/updated
README.md,docs/index.mdx,docs/quickstart.mdx,docs/explanation/artifacts.mdx,docs/explanation/core-concepts.mdx,docs/explanation/prompt-provenance.mdx,docs/guides/human-in-the-loop.mdx,docs/guides/configure-shared-storage.mdx,docs/reference/python-api.mdx,docs/docs.json,llms.txt,examples/README.md,noesis-tui/README.mddocs/reference/llms-txt.mdxCodepaths they cover
noesis/runtime/paths.py,noesis/infrastructure/layout.py,tests/runtime/test_episode_dir_layout.pynoesis/state/episode.py(ep_<ULID>),noesis/runtime/artifacts/ids.pynoesis/domain/process.py(derive_process_identity),noesis/__init__.py(process=),noesis/cli/__main__.py(--process,processes,runs)noesis/domain/config/settings.py(ALLOWED_CONFIG_KEYS; nolabel/seed/log_prompts)noesis/usecases/run_lifecycle.py,tests/runtime/test_run_lifecycle.pynoesis/verification.py,noesis/cli/verification_input.pynoesis/core.py(EpisodeIndexunderlayout.index_dir,ttl_days=30)Key knowledge gaps addressed
.noesis/episodes/<label>/ep_...andns.set(label=...)NOESIS_RUNS_DIR=/srv/noesis/episodesdoes not keep that path as the episodes root unless the parent is named.noesisinterruptafter a sealed run or started a follow-upns.runinstead ofresume_rundocs.jsonpointed atreference/llms-txtwith no page;llms.txtlisted unpublished/deprecated guidesfirst-episode/first-policy/incident-triagetutorials were not in the sidebarTechnical Details
Documentation-only. No runtime, schema, or KPI changes.
Validation
Required
/tmp/noesis-docs-venv/bin/python -m pytest tests/domain/test_process_identity.py tests/runtime/test_episode_dir_layout.py tests/runtime/test_layout_paths.py tests/cli/test_process_commands.py tests/runtime/test_run_lifecycle.py -q(24 passed)docs/docs.jsonparsesSituational
npx --yes mintlify@latest broken-linksfromdocs/— no broken linksgit diff --check; fenced-code blocks balanced;PYTHONPATH=.smoke forderive_process_identity, unknownlabel/log_promptskeys, andep_<ULID>IDsADR-003 Schema Governance Checklist
Not applicable (no schema/KPI changes).
Observability & Safety
No telemetry or behavior changes. Approval docs now warn that sealed runs reject
interrupt/checkpoint(RunSealedError) and that paused runs must not have artifacts hand-edited.Related Issues / References
.noesis/episodes(flatep_<ULID>bundles)tests/runtime/test_run_lifecycle.pyderive_process_identity(workspace|name)[:12]