Repository navigation
chore: roadmap, readme and general docs updates - #399
Merged
Merged
Conversation
Signed-off-by: haoshan98 <haoshanw@gmail.com>
haoshan98
requested review from
bbrowning,
franciscojavierarceo,
jiahuei,
leseb,
maralbahari,
noobHappylife,
qandrew and
tjtanaa
as code owners
September 30, 2026 09:12
franciscojavierarceo
approved these changes
Sep 30, 2026
Signed-off-by: haoshan98 <haoshanw@gmail.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.
Summary
Several user-facing docs had fallen behind
mainor contradicted each other and the code. This PR brings them in line with what has shipped. It changes documentation only.Corrected claims
/v1/messages. It is now listed as shipped; only stateful Messages stays planned.docs/index.mdadvertised "Background execution" and gateway-executed file search. Neither exists yet: background mode is Support asynchronous/background Responses #357, andfile_searchdeclarations parse but are dropped before inference (tool/normalize.rs). Both claims are removed.docs/api/index.mdquoted fixed WebSocket and executor limits (256 KiB SSE lines, 1 MiB events and response budget). These now come from the configurable[responses]settings, which default to 16 MiB and 8 MiB.docs/api/index.mdlisted only some of the conditions that route a Responses request through the executor. The list now also includes non-function tools,multi_agent.enabled, and tool-search state, matchinghandler/http/responses.rs.[Unreleased].Newly documented features
store: true, HTTP/SSE only, default of 3 concurrent subagents, nomax_tool_callsor reasoning summaries). Also new rows in the API table for/v1/responses/compact, the full Conversations routes,/v1/messageswith/v1/messages/count_tokens, and Swagger/OpenAPI (ENABLE_OPENAPI_DOCS). The features list, diagram, and tool ownership table now include MCP, the code interpreter, Claude Code, compaction, and OpenTelemetry.docs/api/index.md: new sections forGET /v1/responses/{response_id}, multi-agent, Conversations, and Messages.[Unreleased]was empty. It now has entries for fix: reject incomplete and malformed Messages streams #345, feat: preserve prompt_cache_key in Responses execution #347, feat(telemetry): add execution traces and upstream context propagation #349, feat: add OpenAI-compatible Conversations API #351/fix: address Conversations API review comments and add cassette tests #370, fix: support retrieval of stored Responses payloads #354, feat: support code interpreter as gateway execution tool #368, Forward Chat Completions to the upstream. #369, feat: [1/2] Model multi-agent Responses items and event lifecycles #372/feat: [2/2] Execute multi-agent HTTP Responses and verify recorded contracts #373, fix: disable Nagle's algorithm on accepted gateway connections (#376) #380, and fix: do not store a store=false continuation of a stored response #387.Roadmap
file_idhydration for Responses requests #356.Smaller fixes
agentic-llm-d,agentic-cli-docs, andpython/agentic_api/.max_tool_calls, matchingexecutor/rehydrate.rs.mkdocs.yamladds the existing but unlinkeddesign/shell-tool.mdto the nav.Not changed: the README's "Rust 1.85+" badge is wrong (1.85 cannot build the lockfile, see #377), but #379 already updates it to 1.88 along with
rust-versionand a CI check, so this PR leaves it alone to avoid a conflict.