Skip to content

Commit b45bee1

Browse files
committed
docs(runtime): document host mode-info contract for registry convergence
Summary: Update runtime module documentation to match the new host mode-info contract used for registry synchronization and additive runtime capability derivation. Why: The implementation now relies on the richest available host ServerModeInfo snapshot so backend Rust can preserve dedicated embedding-sidecar facts during runtime-registry convergence. The README contracts needed to reflect that supported path and warn against narrower core-gateway-only sync flows. What changed: - document in crates/pantograph-embedded-runtime/src/README.md that hosts with extra producer facts should pass a richer ServerModeInfo snapshot into the hosted runtime constructor - document that registry reconciliation should consume the richest available producer snapshot contract instead of bypassing it with a narrower core-gateway-only helper - document in src-tauri/src/llm/README.md that Tauri registry synchronization must use the richer wrapper mode_info() payload so embedding-sidecar facts are preserved Verification: - documentation-only change reviewed against the current runtime and registry implementation
1 parent 256c0ba commit b45bee1

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

crates/pantograph-embedded-runtime/src/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ let runtime = EmbeddedRuntime::with_default_python_runtime(
156156
- Hosts may optionally inject a shared runtime registry; when present, session
157157
runtime load/unload lifecycle is translated into registry reservation
158158
acquire/release operations.
159+
- Hosts that own additional producer snapshots beyond the core
160+
`inference::InferenceGateway` may pass a richer `ServerModeInfo` snapshot
161+
into the hosted runtime constructor so backend Rust can derive registry
162+
observations and additive runtime capabilities from one contract.
159163
- Direct embedded workflow runs may also reconcile Python-sidecar execution
160164
snapshots into that shared registry so producer-specific runtime facts do not
161165
depend on Tauri-only diagnostics paths.
@@ -184,5 +188,10 @@ let runtime = EmbeddedRuntime::with_default_python_runtime(
184188
consumers; a future `RuntimeRegistry` may compose them with admission or
185189
residency state, but this crate must not silently fold policy-level decisions
186190
into those producer contracts.
191+
- Registry reconciliation should consume the richest available producer
192+
snapshot contract, typically a host-owned `ServerModeInfo`; callers should
193+
not bypass that contract with a narrower core-gateway-only helper when
194+
additional producer facts such as the dedicated embedding sidecar are
195+
available.
187196
- If the descriptor contract changes, this directory must regenerate its README
188197
contract text and add ADR coverage if the compatibility boundary expands.

src-tauri/src/llm/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ app.manage(gateway);
117117
single producer-specific runtime snapshots into backend-owned registry
118118
observations, but it must not become the owner of lifecycle or retention
119119
policy.
120+
- When this directory synchronizes registry state from the shared gateway, it
121+
must use the richer Tauri `mode_info()` snapshot rather than the narrower
122+
core-gateway view so dedicated embedding-sidecar facts are not dropped.
120123
- Command payloads emitted from this directory are transport wrappers around
121124
backend/runtime contracts, not a separate policy schema.
122125
- Health/recovery overlays may add host-only fields, but they must not mutate

0 commit comments

Comments
 (0)