Skip to content

docs: misc cleanup for agents#9502

Open
ishandhanani wants to merge 5 commits into
mainfrom
ishan/doc-clean
Open

docs: misc cleanup for agents#9502
ishandhanani wants to merge 5 commits into
mainfrom
ishan/doc-clean

Conversation

@ishandhanani
Copy link
Copy Markdown
Contributor

@ishandhanani ishandhanani commented May 13, 2026


Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Comprehensively expanded HiCache documentation with tier-aware shared KV cache routing specifications, field transitions, configuration options, Prometheus metrics reference, and enhanced troubleshooting guidance including symptom-to-fix mapping.
    • Removed "SGLang for Agentic Workloads" from documentation navigation.

Review Change Stack

@github-actions github-actions Bot added docs documentation Improvements or additions to documentation labels May 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

Walkthrough

This PR updates the HiCache documentation to reflect tier-aware shared KV cache routing and refines operational guidance. The sglang-hicache.md file is updated with clarified tier-aware event transitions, configuration flags, worked examples, and expanded verification/troubleshooting metrics. The navigation config removes a deprecated agentic workloads link.

Changes

HiCache Documentation and Navigation

Layer / File(s) Summary
Document title and HiRadixCache event transitions
docs/backends/sglang/sglang-hicache.md
Title updated from "HiCache" to "Using HiCache"; event transition model explicitly documents tier transitions (GPU/Host/External) and their emitted medium field values.
Configuration flags and worked examples
docs/backends/sglang/sglang-hicache.md
Shared-cache-type configuration flag table added with env var and defaults; worked example table demonstrates how shared-pool hits beyond device overlap influence prefill and worker logit scoring.
Verification and troubleshooting guidance
docs/backends/sglang/sglang-hicache.md
Verification section expanded with new frontend Prometheus metric definitions (shared cache hit rate, beyond-block counts); troubleshooting symptom matrix provides symptom→cause→fix guidance.
Navigation cleanup
docs/index.yml
"SGLang for Agentic Workloads" entry removed from Agents navigation section.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is essentially empty, containing only a Devin Review badge link with no substantive content about the changes, objectives, or implementation details. Complete the description using the provided template: add an Overview section, Details section describing the changes made, point out key files for review (docs/backends/sglang/sglang-hicache.md and docs/index.yml), and include any related GitHub issues.
Title check ❓ Inconclusive The title 'docs: misc cleanup for agents' is vague and overly generic, using the non-descriptive term 'misc cleanup' that does not convey meaningful information about the changeset. Replace with a more specific title reflecting the actual changes, e.g., 'docs: remove SGLang agents documentation and update HiCache guide' or 'docs: update HiCache documentation and remove agents page link'.
✅ Passed checks (3 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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/backends/sglang/sglang-hicache.md`:
- Around line 61-69: The doc uses two different medium labels (`CPU` in the
transition table vs `CPU_PINNED` in the verification example), causing
confusion; choose a single canonical label (e.g., replace all occurrences of
`CPU` in the transition table with `CPU_PINNED` or vice versa) and update every
emitted-event example (e.g., `store(CPU)`, `remove(CPU)`) to match the canonical
label, or alternatively add one clear note mapping `CPU` ↔ `CPU_PINNED` and
reference it where events are listed (ensure `store(CPU)`/`remove(CPU)` and the
verification example use the same term).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6ea54e43-8ce4-4d30-833a-7485e87eedc5

📥 Commits

Reviewing files that changed from the base of the PR and between 78146fe and 38d203a.

📒 Files selected for processing (2)
  • docs/backends/sglang/sglang-hicache.md
  • docs/index.yml
💤 Files with no reviewable changes (1)
  • docs/index.yml

Comment thread docs/backends/sglang/sglang-hicache.md Outdated
Copy link
Copy Markdown

@dynamo-ops dynamo-ops left a comment

Choose a reason for hiding this comment

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

docs/index.yml — This navigation entry still points to the deleted docs/integrations/sglang-hicache.md path, so the HiCache page will be broken in the docs. Fix: update it and other inbound links to backends/sglang/sglang-hicache.md or keep a stub/redirect at the old path.

Comment thread docs/backends/sglang/sglang-hicache.md
- agent-tracing.md: wrap "ATIF alignment" in <details>/<summary>; stray
  closing tags broke Fern's MDX parser.
- sglang-hicache.md: use `CPU_PINNED` consistently to match the value
  SGLang's HiRadixCache actually emits (per CodeRabbit feedback).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Introduces docs/agents/pi-mono.md as the end-to-end "actually try
agent tracing" page, backed by the pi-dynamo-provider extension.
Nav entry added under User Guides > Agents.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@copy-pr-bot copy-pr-bot Bot requested a deployment to GITLAB May 13, 2026 21:41 Pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/XL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants