docs: document process registry operations#227
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 operational contract for grouped episode runs, process-oriented CLI inspection, liveness, and troubleshooting.
Type of Change
Motivation & Context
The process registry subsystem has source-backed behavior for stable process identity, per-process run indexes, process liveness, and CLI filtering, but the public docs only briefly mentioned
noesis processesandnoesis runs. This PR adds a concise operator/developer reference so teams can use and troubleshoot grouped runs without reading implementation code.Technical Details
Docs added/updated:
docs/reference/process-registry.mdxcovering architecture, CLI usage, canonical.noesis/processes/layout, process record fields, artifact links, liveness states, and troubleshooting.docs/reference/cli.mdxwith grouped-run examples, process liveness semantics,runs --jsonoutput shape, and a link to the new runbook.docs/docs.jsonnavigation to include the new reference page.Codepaths covered:
noesis.core._bootstrap_episode,_start_process_heartbeat, and_finalize_episodenoesis.domain.process.derive_process_identityandProcessnoesis.infrastructure.process_registry.FileProcessRegistrynoesis.usecases.process_registry.ProcessRegistryServicenoesis.cli.__main__:run --process,ps --process,processes, andrunsKey knowledge gaps addressed:
--processlabels map to opaque process ids.index.jsonis used/rebuilt.running,stale,idle, anderrormean for operator views.summary.json,state.json, andfinal.json.No runtime code or schemas changed.
Validation
Required
uv run pytest) or equivalent targeted suiteSituational
pnpm run buildin docs/)python scripts/pre_release.py --check-all)Validation performed:
python3JSON/read validation fordocs/docs.json,docs/reference/process-registry.mdx, anddocs/reference/cli.mdxpassed.python3 -m pytest tests/cli/test_process_commands.py tests/infrastructure/test_process_registry.py tests/infrastructure/test_process_registry_concurrency.py tests/infrastructure/test_process_registry_resilience.py tests/usecases/test_process_registry_staleness.py tests/domain/test_process_identity.py8 passed.Notes:
typer; installing the package in editable mode resolved the missing runtime dependency.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 usersSchema checklist not applicable: documentation-only change with no artifact field changes.
Observability & Safety
Improves operational clarity for process liveness and registry troubleshooting. No telemetry, policy logic, or runtime behavior changed.
Educational / Research Value
Helps developers understand how repeated agent workflows are grouped into stable process identities and how those identities connect to episode artifacts.
Screenshots / Logs
Related Issues / References
N/A