docs(readme): clarify verification and resume contracts#233
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
Clarifies the README sections for workspace verification, terminal vs paused artifact contracts, and pause/checkpoint/resume lifecycle behavior. Also fixes a broken code fence in the minimal example so the landing page renders correctly.
Type of Change
Motivation & Context
Recent runtime work tightened verification, artifact sealing, and same-run resume semantics. The top-level README had a malformed verification/lifecycle block and implied every run immediately writes sealed terminal artifacts, which is inaccurate for paused runs.
Technical Details
Docs added/updated:
README.mdintro and "What Noēsis does" artifact wording.verify=...example withfile_exists,file_contains,only_modified, andno_modificationsconstraints.Codepaths covered:
noesis/verification.pyandnoesis/__init__.py.noesis/core.pyandnoesis/usecases/run_lifecycle.py.noesis/domain/run_lifecycle.py.Key knowledge gaps addressed:
resume()evidence-only behavior andresume_run()continuation.Validation
Required
git diff --checkand README fenced-code/section validation scriptSituational
pnpm run buildin docs/) (not run; README-only change outside Mintlify docs app)ADR-003 Schema Governance Checklist
$schema_versionbumped for every artifact whose stable fields changed (not applicable)docs/schema/**regenerated (not applicable)internal_docs/schema/kpi*.yaml(not applicable)MIGRATIONS.schema.mdorMIGRATIONS.kpi.md(not applicable)python scripts/schema_guard.py --strict --jsonpasses locally (not applicable)docs/app/reference/*updated when new fields/KPIs surface to users (not applicable)Observability & Safety
No runtime behavior changed. The docs now call out artifact sealing and resume constraints more precisely.
Screenshots / Logs
Related Issues / References
Automated weekly technical documentation refresh.