docs: document process registry contracts#226
Draft
cursor[bot] wants to merge 1 commit intomainfrom
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 process registry contract across the public Python API, CLI workflows, and persisted artifacts. This is a documentation-only update for the existing process grouping subsystem.
Type of Change
Motivation & Context
Recent runtime and CLI surfaces expose process grouping via
process=.../--process, process liveness inspection, andprocessblocks insummary.jsonandstate.json. The docs did not yet explain how process names, opaque process IDs, run indices, and filters fit together.Technical Details
docs/reference/python-api.mdxforns.run(..., process=...),ns.solve(..., process=...), andnoesis.io.list_runs()process rows.docs/reference/cli.mdxwith grouped-run examples, process liveness status meanings, filter usage, andruns --jsonoutput shape.docs/reference/summary.mdxanddocs/reference/state.mdxwith the persistedprocessartifact block and field semantics.noesis/__init__.py,noesis/domain/process.py,noesis/infrastructure/process_registry.py,noesis/usecases/process_registry.py,noesis/cli/__main__.py, and state/summary serialization code.Validation
Required
uv run pytest) or equivalent targeted suiteValidation performed:
git diff --check HEAD~1..HEADpassed. No runtime code or schema files changed.Situational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)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 contract changed; this PR documents existing fields.
Observability & Safety
Clarifies that process liveness is best-effort registry metadata and that process IDs are opaque machine references derived from workspace identity plus process label.
Educational / Research Value
Helps operators and developers connect grouped episode runs to the process registry and artifact fields without reading implementation code.
Screenshots / Logs
git diff --check HEAD~1..HEADpassed.Related Issues / References
Source paths verified:
noesis/domain/process.py,noesis/infrastructure/process_registry.py,noesis/cli/__main__.py,noesis/runtime/summary.py,noesis/domain/state/models.py.