docs: document process identity workflows - #236
Draft
cursor[bot] wants to merge 1 commit into
Draft
cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
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 process identity workflows and state authority boundaries for process-scoped runs.
Docs added/updated:
docs/reference/state.mdx: documentsstate.process, fields, constraints, and resume requirement.docs/reference/cli.mdx: adds home-screen behavior, process grouping examples, process liveness fields, JSON shapes, and troubleshooting.docs/reference/python-api.mdx: documents theprocessparameter forns.run,ns.solve, and sessions.docs/explanation/artifacts.mdx: adds a concise authority model for trace-derived, registry-backed, and persisted state slices.Type of Change
Motivation & Context
Recent runtime and state work made process identity operationally important, but public docs did not explain
state.process, process-scoped CLI workflows, or which state slices are trace-derived versus registry-backed.Technical Details
Codepaths covered and verified against:
noesis/domain/process.pynoesis/infrastructure/process_registry.pynoesis/usecases/process_registry.pynoesis/core.pynoesis/domain/state/models.pynoesis/infrastructure/state_repository.pynoesis/cli/__main__.pyKey knowledge gaps addressed:
process.id,process.name,process.kind, andprocess.run_indexare emitted and used.--process, inspect registry liveness, and filter process runs.state.processis registry-backed whileplan,outcomes, andlinkshave trace/projection authorities.Validation
Required
/tmp/noesis-docs-venv2/bin/python -m pytest tests/cli/test_process_commands.py tests/domain/test_process_identity.py tests/cli/test_home_help.py -q(19 passed)Situational
cd docs && npx --yes mintlify@latest broken-links(success, no broken links)python scripts/pre_release.py --check-all)Additional check:
git diff --check HEAD~1..HEADADR-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 users (equivalent Mintlify reference docs updated underdocs/reference/*)Observability & Safety
No runtime behavior changed. The new docs clarify operational liveness versus persisted state snapshots so operators do not treat stale
state.processdata as current registry state.Educational / Research Value
Screenshots / Logs
Related Issues / References
Automated documentation maintenance run for process identity and state authority gaps.