Skip to content

fix: KV Router bindings docs#3308

Merged
PeaBrane merged 1 commit into
mainfrom
rupei/router-docs-fix-bindings-component
Sep 30, 2025
Merged

fix: KV Router bindings docs#3308
PeaBrane merged 1 commit into
mainfrom
rupei/router-docs-fix-bindings-component

Conversation

@PeaBrane
Copy link
Copy Markdown
Contributor

@PeaBrane PeaBrane commented Sep 30, 2025

Overview:

changed to the correct component and endpoint names

Summary by CodeRabbit

  • Documentation
    • Updated architecture guide examples to use the “dynamo” namespace and “backend” component when calling the “generate” endpoint.
    • Refreshed Python examples to reflect the new routing path while keeping the endpoint name unchanged.
    • Clarified usage so developers can follow the current routing scheme without code changes to their generate calls.

Signed-off-by: PeaBrane <yanrpei@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 30, 2025

Walkthrough

Documentation update adjusting two Python snippets in kv_cache_routing to use namespace "dynamo" and component "backend" instead of "inference" and "vllm" when resolving the "generate" endpoint. No other routing logic or behavior altered.

Changes

Cohort / File(s) Summary
Docs: KV cache routing examples
docs/architecture/kv_cache_routing.md
Updated Python code samples to fetch the "generate" endpoint via namespace "dynamo" and component "backend" instead of "inference"/"vllm". No other content or logic changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers, hop with glee,
Routes aligned as neat can be—
From inference fields to dynamo streams,
Backend hums with generate dreams.
Tiny tweak, a tidy track,
Thump! goes joy in bunny’s pack. 🐇✨

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The description only provides an Overview section and does not include the required Details, Where should the reviewer start, or Related Issues sections specified in the repository template, leaving out context on the specific changes, review locations, and issue links. Please expand the description to include a Details section describing the specific edits made in the docs, a Where should the reviewer start section identifying the files or lines to focus on, and a Related Issues section linking any relevant GitHub issues.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title clearly and concisely indicates that the documentation for KV Router bindings is being fixed, which directly corresponds to the changes in the docs file without extra noise or ambiguity, making it easy for a reader to understand the main purpose of the PR.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74a5667 and 4cc5b05.

📒 Files selected for processing (1)
  • docs/architecture/kv_cache_routing.md (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: PeaBrane
PR: ai-dynamo/dynamo#3184
File: docs/architecture/kv_cache_routing.md:70-73
Timestamp: 2025-09-23T20:08:37.105Z
Learning: PeaBrane prefers to keep documentation diagrams simplified to avoid visual overload, even when this means sacrificing some technical precision for the sake of clarity and comprehension. They prioritize pedagogical effectiveness over exhaustive technical detail in architectural diagrams.
Learnt from: PeaBrane
PR: ai-dynamo/dynamo#2756
File: lib/llm/src/kv_router/subscriber.rs:36-44
Timestamp: 2025-08-29T10:03:48.330Z
Learning: PeaBrane prefers to keep PRs contained in scope and is willing to defer technical improvements to future PRs when the current implementation works for the immediate use case. They acknowledge technical debt but prioritize deliverability over completeness in individual PRs.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and Test - dynamo
🔇 Additional comments (2)
docs/architecture/kv_cache_routing.md (2)

333-334: LGTM! Documentation corrected to use proper namespace and component names.

The update from namespace("inference").component("vllm") to namespace("dynamo").component("backend") aligns with the actual system architecture as indicated in the PR objectives.


399-400: LGTM! Consistent update across both code examples.

This change maintains consistency with the first code snippet (lines 333-334), ensuring both Python examples use the correct namespace("dynamo") and component("backend") references.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

@PeaBrane PeaBrane merged commit f004178 into main Sep 30, 2025
19 checks passed
@PeaBrane PeaBrane deleted the rupei/router-docs-fix-bindings-component branch September 30, 2025 18:48
PeaBrane added a commit that referenced this pull request Oct 1, 2025
Signed-off-by: PeaBrane <yanrpei@gmail.com>
yao531441 pushed a commit to yao531441/dynamo that referenced this pull request May 13, 2026
Signed-off-by: PeaBrane <yanrpei@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants