docs: add routing strategies table and the libsy library path

[ryan-lempka]

Addressing some feedback on docs gaps.

Summary by CodeRabbit

• Documentation
  • Added Quick Start guidance for embedding the routing library in Rust applications.
  • Documented dependency setup and supported routing strategies, including classifier, stage, escalation, random, and passthrough routes.
  • Expanded the getting started guide with the library execution path and step-stream workflow.
  • Updated navigation and next steps to reflect the new guidance.

[github-actions]

PR Preview Action v1.8.1
🚀 View preview at https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-331/
Built to branch gh-pages at 2026-08-07 18:05 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[coderabbitai]

Walkthrough

The documentation adds direct Rust embedding through switchyard-libsy. It documents Cargo dependencies, routing strategies, server route compatibility, host-managed Step::CallLlm operations, and Step::ReturnToAgent responses.

Changes

Library execution documentation

Layer / File(s)	Summary
Document library execution paths README.md, docs/getting_started.md	The Quick Start and getting-started guide now list direct Rust embedding through switchyard-libsy alongside existing execution paths.
Describe library routing and step flow README.md, docs/getting_started.md	The documentation adds dependency setup, routing algorithms, route types, host-managed model calls, and final response delivery through algorithm steps.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

I’m a rabbit with docs in my paws,
Routing through paths without pause.
CallLlm hops in,
ReturnToAgent wins,
Rust libraries now follow the laws.

🚥 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 two primary documentation changes: the routing strategies table and the libsy library path.
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.

---

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

README.md (1)

104-108: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Pin the library dependency source in both quick-start examples.

Both snippets resolve switchyard-libsy and switchyard-protocol from the moving default branch. Use the same published version or immutable commit in both files.

• README.md#L104-L108: pin both Git dependencies or use published versions.
• docs/getting_started.md#L246-L253: apply the same pinned source and keep the two dependencies aligned.

🤖 Prompt for 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.

In `@README.md` around lines 104 - 108, Pin both switchyard-libsy and
switchyard-protocol dependencies in README.md lines 104-108 to the same
published version or immutable commit. Apply the identical aligned pin to both
dependencies in docs/getting_started.md lines 246-253.

🤖 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/getting_started.md`:
- Around line 264-266: Update the escalation row in the route-strategy
documentation to include type = "llm_classifier" and mode = "escalation", and
identify escalation = { ... } as the optional configuration block.

In `@README.md`:
- Around line 110-111: Change the README sentence around the Getting Started
link to call the library-path section an “overview” rather than a “worked
example,” unless you add a minimal executable Rust flow demonstrating drive, the
host serve callback, and CallLlmRequest::respond.

---

Nitpick comments:
In `@README.md`:
- Around line 104-108: Pin both switchyard-libsy and switchyard-protocol
dependencies in README.md lines 104-108 to the same published version or
immutable commit. Apply the identical aligned pin to both dependencies in
docs/getting_started.md lines 246-253.

🪄 Autofix

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: Enterprise

Run ID: 2023ccc1-df58-4a6a-8d50-9e2f9fb3e066

📥 Commits

Reviewing files that changed from the base of the PR and between 8d6adfe and f099a19.

📒 Files selected for processing (2)

• README.md
• docs/getting_started.md