docs: document final artifact sealing#232
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
Documents the
final.jsonartifact sealing contract for terminal episode runs and wires the final schema into the docs reference navigation.Type of Change
Motivation & Context
The runtime and tests define
final.jsonas the canonical seal marker, but the main artifact docs did not explain the contract. This PR closes that gap for developers and operators reading episode artifacts.Technical Details
docs/reference/final.mdxfor thefinal/2.0.0schema, outcome values, verification status values, lifecycle constraints, and examples.docs/explanation/artifacts.mdxwithfinal.json, sealing order, manifest rollback behavior, pause-on-veto constraints, and a corrected manifest verification snippet.docs/explanation/core-concepts.mdx,docs/index.mdx,docs/quickstart.mdx, anddocs/guides/adopting-noesis.mdx.reference/finaltodocs/docs.jsonunder Schema reference.Validation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/) or equivalent docs checkpython scripts/pre_release.py --check-all)Validation run:
npx --yes mintlify@latest broken-linksfromdocs/reference/final, schema presence, andfinal/2.0.0enum contract/tmp/noesis-docs-venv/bin/python -m pytest tests/runtime/test_sealing_flow.py tests/runtime/test_final_schema.py tests/runtime/test_run_lifecycle.py -q(22 passed)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 fields changed; this is documentation for the existing
docs/schema/final/2.0.0.jsoncontract.Observability & Safety
Clarifies the operational distinction between sealed terminal runs and unsealed paused runs, including
RunSealedErrorbehavior and manifest rollback semantics.Educational / Research Value
Improves trace literacy for teams auditing Noēsis episode bundles and trace-based evals.
Screenshots / Logs
N/A.
Related Issues / References
Verified against:
noesis/core.pynoesis/domain/artifacts/finalization.pynoesis/usecases/finalization.pynoesis/usecases/immutability.pynoesis/usecases/run_lifecycle.pytests/runtime/test_sealing_flow.pytests/runtime/test_final_schema.pytests/runtime/test_run_lifecycle.py