docs: process identity, checkpoint resume hashes, and README repair - #238
Draft
cursor[bot] wants to merge 2 commits into
Draft
docs: process identity, checkpoint resume hashes, and README repair#238cursor[bot] wants to merge 2 commits into
cursor[bot] wants to merge 2 commits into
Conversation
The landing page mixed verification and resume snippets and pointed at removed docs/app paths. Restore working examples and current artifact layout, including unsealed paused runs and process identity. Co-authored-by: Sara Loera <sara@saraeloop.com>
Document operator process identity (CLI --process, process registry, summary/state process blocks) and fail-closed resume checks including artifact_manifest_hash. Add the missing llms-txt reference page and align nav plus root llms.txt with pages that exist. 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
Keep operator and developer docs aligned with the current runtime: process identity, fail-closed checkpoint resume, sealed vs paused artifact layout, and a usable README.
Type of Change
Motivation & Context
Recent runtime work (#210 checkpoint manifest integrity, process registry/CLI,
final.jsonsealing) was only partly reflected in docs. The README also mixed verification and resume examples and linked to removeddocs/app/...paths.docs.jsonpointed at a missingreference/llms-txtpage.Docs added/updated
README.md,docs/explanation/artifacts.mdx,docs/explanation/core-concepts.mdx,docs/reference/python-api.mdx,docs/reference/cli.mdx,docs/reference/events.mdx,docs/reference/summary.mdx,docs/guides/human-in-the-loop.mdx,docs/guides/configure-shared-storage.mdx,docs/quickstart.mdx,docs/docs.json,llms.txtdocs/reference/llms-txt.mdxCodepaths they cover
noesis/domain/process.py,noesis/usecases/process_registry.py,noesis/__init__.py(process=),noesis/cli/__main__.py(--process,processes,runs)noesis/usecases/run_lifecycle.py,noesis/domain/run_lifecycle.py(artifact_manifest_hash,CheckpointConsistencyError)noesis/core.py_seal_episode,noesis/domain/artifacts/finalization.py,noesis/runtime/paths.pyKey knowledge gaps addressed
artifact_manifest_hashand the fail-closed manifest appear/disappear cases from fix(lifecycle): enforce checkpoint artifact integrity during resume #210final.json/checkpoints// unsealed paused runsreference/llms-txtbut the page did not exist;llms.txtlisted unpublished guidesTechnical Details
Documentation-only. No runtime, schema, or KPI changes.
Validation
Required
uv run pytest) or equivalent targeted suite — docs-only;uv/pytestnot usedSituational
npx --yes mintlify@latest broken-linksfromdocs/reported no broken linksPYTHONPATH=.import ofderive_process_identitymatches documentedsha256(workspace|name)[:12]; fenced-code blocks balanced;git diff --checkcleanADR-003 Schema Governance Checklist
Not applicable (no schema/KPI changes).
Observability & Safety
No telemetry or behavior changes. Resume troubleshooting now documents fail-closed artifact hash checks so operators do not hand-edit paused episode files.
Related Issues / References
noesis processes+ns.run(..., process=...)