Skip to content

docs: remove stale source-build notices - #859

Merged
ryan-lempka merged 1 commit into
mainfrom
docs/remove-source-build-notices
Sep 28, 2026
Merged

ryan-lempka merged 1 commit into
mainfrom
docs/remove-source-build-notices

Conversation

@ryan-lempka

@ryan-lempka ryan-lempka commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

Remove the stale source-build notices now that v0.3.0 is published.

Validated all four documented configurations with the crates.io v0.3.0 server using --dry-run. The strict docs build also passes.

Summary by CodeRabbit

  • Documentation
    • Updated the getting started and routing guides by removing notices that certain examples required unreleased features or a build from source.
    • The guides now present the server configuration, LLM classifier routing, Auto routing, and subagent routing examples without those warnings.

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

Copy link
Copy Markdown
PR Preview Action v1.8.1

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

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

@coderabbitai

coderabbitai Bot commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their 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: d2847498-7da1-4673-ae17-de9a367d96aa

📥 Commits

Reviewing files that changed from the base of the PR and between 64def56 and a11a964.

📒 Files selected for processing (4)
  • docs/getting_started.md
  • docs/routing_algorithms/llm_classifier_routing.md
  • docs/routing_algorithms/overview.md
  • docs/routing_algorithms/subagent_routing.md
💤 Files with no reviewable changes (4)
  • docs/routing_algorithms/subagent_routing.md
  • docs/routing_algorithms/overview.md
  • docs/getting_started.md
  • docs/routing_algorithms/llm_classifier_routing.md

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


Walkthrough

Four documentation pages no longer contain notices that examples require unreleased features or a source build.

Changes

Routing documentation

Layer / File(s) Summary
Remove source-build notices
docs/getting_started.md, docs/routing_algorithms/overview.md, docs/routing_algorithms/llm_classifier_routing.md, docs/routing_algorithms/subagent_routing.md
Removed notices about unreleased features and source builds from the getting-started guide and routing documentation.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to a11a9

No actionable issue with the notice cleanup was established. The change is mergeable after normal checks.

🚥 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 and concisely describes the main change: removing outdated source-build notices from the documentation.
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 read the routing guide,
No source-build note remained inside.
Four pages shed their warning lines,
The examples stand in clearer signs.
I hop away through docs refined!

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

@afourniernv afourniernv 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

@ryan-lempka
ryan-lempka merged commit ccac48e into main Sep 28, 2026
17 checks passed
@ryan-lempka
ryan-lempka deleted the docs/remove-source-build-notices branch September 28, 2026 16:25
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