Skip to content

docs: fix client setup and Responses state guidance - #809

Merged
ayushag-nv merged 1 commit into
mainfrom
docs/fix-release-integration-guidance
Sep 21, 2026
Merged

ayushag-nv merged 1 commit into
mainfrom
docs/fix-release-integration-guidance

Conversation

@ryan-lempka

@ryan-lempka ryan-lempka commented Sep 21, 2026

Copy link
Copy Markdown
Collaborator

Fix Codex setup and Rust client examples, and clarify Responses history retention. Docs only.

Summary by CodeRabbit

  • Documentation
    • Updated standalone proxy setup instructions to use the dedicated switchyard Codex provider and route, with authentication through OPENROUTER_API_KEY.
    • Refreshed LLM client examples, dependency references, protocol links, and routing usage.
    • Clarified response continuation behavior across native and cross-format providers, including conversation history, routing consistency, capacity limits, unknown IDs, and conflict responses.

Signed-off-by: Ryan Lempka <rlempka@nvidia.com>
@ryan-lempka
ryan-lempka requested a review from a team as a code owner September 21, 2026 15:38
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

🚀 View preview at
https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-809/

Built to branch gh-pages at 2026-09-21 15:39 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NVIDIA-NeMo/Switchyard/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fcb98e97-a806-4975-b74d-3a2b9e05e90c

📥 Commits

Reviewing files that changed from the base of the PR and between da8133b and 807801a.

📒 Files selected for processing (3)
  • README.md
  • crates/libsy-llm-client/README.md
  • docs/routing_algorithms/llm_classifier_routing.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

The pull request updates setup instructions, Rust client examples, protocol references, and Responses continuation documentation. It documents Codex provider configuration, RuntimeModels usage, cross-format history retention, model preservation, and capacity behavior.

Changes

Documentation and Routing

Layer / File(s) Summary
Codex provider setup
README.md
The instructions configure Codex CLI with the switchyard provider and local Responses API. They state that upstream authentication uses OPENROUTER_API_KEY.
LLM client examples
crates/libsy-llm-client/README.md
Dependency paths and protocol links are updated. The routing example passes RuntimeModels to run.
Responses continuation behavior
docs/routing_algorithms/llm_classifier_routing.md
The documentation distinguishes native Responses storage from locally retained cross-format history. It documents model preservation, capacity handling, and unknown-ID routing.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies the documentation changes to client setup and Responses state guidance. It is concise and specific enough for the documented changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

A rabbit tunes the route with care
Codex hops through fresh provider air
Runtime models join the run
Stored replies remember which model won
Old IDs stay useful in the queue
New docs make the pathways clear too

Comment @coderabbitai help to get the list of available commands.

@ayushag-nv
ayushag-nv merged commit 26c7e89 into main Sep 21, 2026
18 checks passed
@ayushag-nv
ayushag-nv deleted the docs/fix-release-integration-guidance branch September 21, 2026 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants