Skip to content

Switchyard lets LLM applications route traffic across models and providers while preserving native OpenAI and Anthropic API compatibility - enabling flexible model selection, benchmarking, and cost/performance optimization.

Rust

docs: clarify source requirements for unreleased examples (#753)

ryan-lempka98e5a98fcb0c
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 389b02390..17e807d6a 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -62,12 +62,25 @@ switchyard-server --help
Cargo builds the release binary and installs it into `~/.cargo/bin` by default.
+#### Build from source
+
+Install the server from `main` to use unreleased features:
+
+```bash
+cargo install --locked \
+ --git https://github.com/NVIDIA-NeMo/Switchyard.git \
+ --branch main \
+ switchyard-server
+```
+
### Configure
The Rust server reads an explicit TOML file.
Create `routes.toml` with an auto route:
+> Requires unreleased features. [Build from source](#build-from-source) to run this example.
+
```toml
schema_version = 1
diff --git a/docs/routing_algorithms/llm_classifier_routing.md b/docs/routing_algorithms/llm_classifier_routing.md
index c1b3a3fbe..d009665e8 100644
--- a/docs/routing_algorithms/llm_classifier_routing.md
+++ b/docs/routing_algorithms/llm_classifier_routing.md
@@ -9,6 +9,8 @@ This example uses the packaged classifier prompt as intended: it estimates
whether the weak target can complete the task, and keeps the first routing
decision for later requests in the same conversation.
+> Requires unreleased features. [Build from source](../getting_started.md#build-from-source) to run this example.
+
```toml
schema_version = 1
diff --git a/docs/routing_algorithms/stage_router_routing.md b/docs/routing_algorithms/stage_router_routing.md
index 362b7c540..59489c166 100644
--- a/docs/routing_algorithms/stage_router_routing.md
+++ b/docs/routing_algorithms/stage_router_routing.md
@@ -175,6 +175,8 @@ Validate the threshold with routed runs on the same tasks.
## Route configuration
+> Requires unreleased features. [Build from source](../getting_started.md#build-from-source) to run this example.
+
```toml
schema_version = 1
diff --git a/docs/routing_algorithms/subagent_routing.md b/docs/routing_algorithms/subagent_routing.md
index d22d2eb33..c02af0de2 100644
--- a/docs/routing_algorithms/subagent_routing.md
+++ b/docs/routing_algorithms/subagent_routing.md
@@ -4,6 +4,8 @@ Sub-agent-aware routing leaves parent-agent traffic with its configured routing
algorithm while routing delegated sub-agent work separately. It is available on
`passthrough` and `stage_router` routes through the optional `subagents` table.
+> Requires unreleased features. [Build from source](../getting_started.md#build-from-source) to run this example.
+
```toml
schema_version = 1