docs: document final artifact sealing contract - #235
Draft
cursor[bot] wants to merge 1 commit into
Draft
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
Adds first-class documentation for the
final.jsonterminal sealing contract and updates the artifacts explanation so final markers, checkpoint files, and manifest inclusion are easier to reason about.Type of Change
Motivation & Context
The
final/2.0.0schema existed, but the public docs did not have a dedicated final artifact reference. The artifact overview also omittedfinal.json, checkpoint placement, and the exact terminal vs paused-run sealing behavior.Technical Details
Docs added/updated:
docs/reference/final.mdxwith schema fields, outcome mapping, sealing lifecycle, paused-run constraints, and operational checks.docs/explanation/artifacts.mdxto includefinal.json,checkpoints/, sealing order, manifest coverage, and corrected the manifest verification example to use thefilesarray shape.reference/finalto the Schema reference navigation indocs/docs.json.Codepaths covered:
noesis/domain/artifacts/finalization.py(FinalizationRecord, schema constants, outcome vocabulary)noesis/usecases/finalization.py(runtime outcome to final contract mapping)noesis/core.py(_seal_episode,_finalize_episodesealing order and rollback)noesis/usecases/run_lifecycle.py(sealed-run guardrails, checkpoint files, pause/resume lifecycle)noesis/runtime/artifacts/writer.py(manifest default and untracked artifact inclusion)Key knowledge gaps addressed:
outcomeandverification_statusinfinal.json.final.jsonandmanifest.jsonshould be checked together for sealed-run evidence.Validation
Required
git diff --check HEAD~1..HEADpython3 -m json.tool docs/docs.jsonandpython3 -m json.tool docs/schema/final/2.0.0.jsonSituational
npx --yes mintlify@latest broken-linksfromdocs/Observability & Safety
Documentation-only change. No runtime behavior, schema, telemetry, or policy semantics changed.
Educational / Research Value
Improves operator and developer understanding of sealed evidence bundles, terminal artifacts, and pause/resume auditability.
Screenshots / Logs
Validation output:
Related Issues / References
Source-backed against the finalization, run lifecycle, and manifest writer implementations listed above.