Skip to content

docs: Remove old x-model-router-rationale header - #473

Merged
ayushag-nv merged 1 commit into
mainfrom
gk-doc-tweak
Aug 18, 2026
Merged

docs: Remove old x-model-router-rationale header#473
ayushag-nv merged 1 commit into
mainfrom
gk-doc-tweak

Conversation

@grahamking

@grahamking grahamking commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

We don't provide free-form routing info to the user, just the model that
was selected. The free-form info goes in logs.

Signed-off-by: Graham King grahamk@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Removed documentation for the x-model-router-rationale response header from the observability guide.

We don't provide free-form routing info to the user, just the model that
was selected. The free-form info goes in logs.

Signed-off-by: Graham King <grahamk@nvidia.com>
@grahamking
grahamking requested a review from a team as a code owner August 18, 2026 19:03
@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 45cf2a5a-131f-4a04-b348-559a0c0e6013

📥 Commits

Reviewing files that changed from the base of the PR and between ac7a16b and c62a1d1.

📒 Files selected for processing (1)
  • docs/routing_algorithms/stage_router_routing.md
💤 Files with no reviewable changes (1)
  • docs/routing_algorithms/stage_router_routing.md

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


Walkthrough

The routing documentation removes the x-model-router-rationale response header and its human-readable routing reason.

Changes

Routing documentation

Layer / File(s) Summary
Remove obsolete routing header documentation
docs/routing_algorithms/stage_router_routing.md
The documentation no longer describes the x-model-router-rationale response header.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to c62a1

This change only removes an outdated documentation header and does not alter product behavior; no actionable merge-blocking risk remains.

Poem

I’m a rabbit with a tidy pen,
One stale header leaves the den.
The routing guide is clear and bright,
No extra reason in sight.
Hop, hop—docs now match the flight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the removal of the outdated x-model-router-rationale header documentation.

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

@ayushag-nv

Copy link
Copy Markdown
Contributor

@grahamking what other headers still exists which are emitted with model routing ? is it just the selected model ? I remember earlier I added bunch of 4-5 headers but that was long ago in python version

@grahamking grahamking changed the title doc: Remove old x-model-router-rationale header docs: Remove old x-model-router-rationale header Aug 18, 2026
@grahamking

grahamking commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

@grahamking what other headers still exists which are emitted with model routing ? is it just the selected model ? I remember earlier I added bunch of 4-5 headers but that was long ago in python version

Yes, just x-model-router-selected-model. I suspect none of the others came over to Rust, and the docs weren't updated.

@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

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

Built to branch gh-pages at 2026-08-18 19:26 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@ayushag-nv ayushag-nv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ayushag-nv
ayushag-nv merged commit 395c202 into main Aug 18, 2026
15 of 17 checks passed
@ayushag-nv
ayushag-nv deleted the gk-doc-tweak branch August 18, 2026 19:41
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.

3 participants