Skip to content

docs(reference): document the advisor route type in the TOML schema - #625

Merged
ayushag-nv merged 1 commit into
mainfrom
eric-liu/switch-1315-documentation-advisor-review-gate
Sep 8, 2026
Merged

docs(reference): document the advisor route type in the TOML schema#625
ayushag-nv merged 1 commit into
mainfrom
eric-liu/switch-1315-documentation-advisor-review-gate

Conversation

@eric-liu-nvidia

@eric-liu-nvidia eric-liu-nvidia commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

What

  • Adds the missing advisor section to the TOML schema reference: every other route type (noop, passthrough, random, prefill_router, llm_classifier, stage_router, composite) was already documented there, but the advisor review gate's keys were not.
  • Corrects the advisor-gate page's review-budget paragraph: the budget scope has three tiers (proxy_x_session_id header, then the session id resolved from harness headers, then one scope per server), and the page previously omitted the middle tier.

Why

The advisor route is configured through the same TOML deployment file as every other route type; operators looking up keys in the schema reference found nothing for it. Key names, defaults, and validation rules in the new table were verified against AlgorithmSpec::Advisor and AdvisorGate::new.

Validation

  • cd docs && make publish (strict MkDocs build) passes
  • uv run ruff check . and uv run pytest tests/ pass

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Added the advisor routing mode, which can review terminal or pattern-matching turns, approve output, or request a retry with feedback.
    • Added configuration options for review limits, stall and tool-result thresholds, generation settings, transcript size, failure handling, and custom prompts.
  • Documentation

    • Documented session review-budget routing, including fallback to harness-provided session identifiers or server-level scope when no session ID is available.

@eric-liu-nvidia
eric-liu-nvidia requested a review from a team as a code owner September 4, 2026 15:40
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

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

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

@coderabbitai

coderabbitai Bot commented Sep 4, 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: 3a58a553-48a0-4d41-a177-0147f7459f78

📥 Commits

Reviewing files that changed from the base of the PR and between 4022b67 and e23fa6d.

📒 Files selected for processing (2)
  • docs/reference/toml_schema.md
  • docs/routing_algorithms/advisor_gate_routing.md

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


Walkthrough

The documentation adds the advisor route configuration to the TOML schema. It also documents session-header fallback for review-budget routing and preserves existing consult failure and verdict behavior.

Changes

Advisor Route Documentation

Layer / File(s) Summary
Advisor route configuration
docs/reference/toml_schema.md
Documents executor and advisor targets, review triggers, limits, thresholds, generation settings, transcript handling, failure behavior, and review prompts.
Review-budget session scope
docs/routing_algorithms/advisor_gate_routing.md
Documents fallback from proxy_x_session_id to harness session headers and then server scope. Failed consults refund budget, and unparseable verdicts pass through as APPROVE.

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

Merge Risk: ⚪ Minimal · up to e23fa

This change documents advisor-route configuration and session-scoped review-budget fallback behavior. No current merge-readiness risk remains.

Poem

I twitch my nose at routes anew
Advisor gates review each queue
Session headers mark the trail
Approved thoughts or redo mail
A rabbit stamps the schema true

🚥 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 clearly describes the primary change: documenting the advisor route type in the TOML schema. It does not mention the related advisor-gate documentation update, but the title does not need …
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.

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

Signed-off-by: zengyuanl <zengyuanl@nvidia.com>
@ayushag-nv
ayushag-nv merged commit a337669 into main Sep 8, 2026
15 checks passed
@ayushag-nv
ayushag-nv deleted the eric-liu/switch-1315-documentation-advisor-review-gate branch September 8, 2026 15:50
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