docs: consolidate Runtime, sandbox and machine protocols - #283
Merged
Merged
Conversation
… contract Runtime observations, Session history and node host history share one Core-key API document; collection, storage, OTLP export and provider mapping share one internal contract. The design document, the separate history and node host history documents are removed. Session diagnostics keep their own contract without restated rules.
Each Harness page holds its native pin, adapter rules, failure classification and Runtime image contents. The E2B deploy page covers the template build and the application-managed launch; the E2B and microsandbox helper READMEs are reference Provider adapter docs. The microsandbox deploy page is merged into its helper README. Operator copies, stale model-provider routes, acceptance history and restated contracts are removed.
The protocol document gains the capability declarations with Core's admission rule for each, the opt-ins Core sets, the active-input receipt timers and native failure classification (from the deleted classification contract). The Executor and Turn adapter lifecycle moves to Harness onboarding; preparation, image and MCP restatements become links. Runtime bootstrap names its Go projection and links every credential source.
machine-api.md is the single /api/v1 document: routes, credential kinds including the operator device profile, node and daemon payloads and errors. The node protocol document covers the whole Core-to-node connection. The deployment contract lists every sandbox route and drops placement, history and qualification prose; node diagnostics follow the generation-managed rollout. The Sandbox Provider guide documents RunCommandCompute, marks the shared-code registration steps as known gaps and gains the managed lifecycle Core runs around every provider.
The service README becomes a contributor guide: commands, database, run from source, tests and generated contracts. Operator, API and enrollment material leaves for its owners. IMPLEMENTATION.md keeps only code-level constraints; restated contracts, history and the sandbox chapter go to their owners, Vault rules link to the credential guide, and Codex adapter constraints move to the Codex Runtime page.
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
1 participant
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.
Give the Core–Runtime wire, sandbox node protocol, machine HTTP API, managed Provider lifecycle and telemetry clear owning documents. Reduce the service README to contributor setup and keep only internal mechanisms in IMPLEMENTATION.md; merge adapter and telemetry details from superseded documents.
Independent review completed. Corrected operation-specific node success responses and compute generation arguments, Session status precedence, provider extension guidance and Agent update timestamps. Integration preserves current API mechanisms and the shared diagnostic fixture contract.
Validation passed: name guard, distribution checks, repository Markdown links, and focused Core/machine route plus Diagnostic tests. After integration with API, scripts and node diagnostic changes, the name guard, 19 distribution-manifest tests and focused API tests passed again. Code and wire definitions are unchanged.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.