docs(framework): add Runtime page under the Agent section#602
Merged
Conversation
Document the pluggable agent runtime (Agent(runtime=...)): the adk default vs the codex runtime, how to switch, codex requirements (openai-codex extras, model_api_base/key, model resolution), how it works (Responses->Chat shim, isolated CODEX_HOME, instruction preamble), the harness `runtime`/`--runtime` switch, and how to add a custom runtime. Registered after responses-api in the agent nav (zh + en).
zakahan
approved these changes
Jun 11, 2026
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
2 participants
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.
What
Adds a dedicated Runtime doc page under the framework Agent section, in both languages. The pluggable agent runtime (
Agent(runtime=...),veadk/runtime/) previously had no documentation —runtime/codexonly appeared as a harness CLI flag.Pages
docs/content/docs/framework/agent/runtime.mdx(中文「运行时」)docs/content/docs/framework/agent/runtime.en.mdx(English "Runtime")Registered in the agent nav (
meta.json/meta.en.json) right afterresponses-api.Contents
Sourced from
veadk/runtime/andveadk/agent.py:Agent(runtime=...)selects who drives the agent loop;Runnerstill owns session/memory/tracing.adk(default) vscodexcomparison.Agent(runtime="codex").pip install openai-codex fastapi uvicorn), requiredmodel_api_base/model_api_key, model resolution (model_name→OPENAI_MODEL), and how it works (Responses→Chat shim, isolatedCODEX_HOME, instruction folded into a preamble).codex-auto-reviewmodel needing endpoint access.runtime/--runtimeswitch.get_runtime/BaseRuntime).Notes
.mdxfollows the existing framework page style.