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: Add component diagram (#945)

Graham King3a918cb949b1
diff --git a/AGENTS.md b/AGENTS.md
index b9a329cfd..c0749d469 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -17,7 +17,13 @@ Integrations:
- `crates/switchyard-nemo-relay-plugin/`: Integrate with NeMo Relay.
- `examples/litellm/`: Integrate with LiteLLM.
-Write for a high-school level in short, simple sentences. Avoid jargon, analogies and metaphors. Be direct.
+## Writing guidance
+
+- Write for a high-school level in short, simple sentences.
+- Avoid jargon, analogies and metaphors. Be direct.
+- Only say what something is not if it is essential to understanding. Never use negatives or opposites as a rhetorical flourish.
+- Be humble. Do not inflate claims.
+- Do not say what you would do unless asked.
## Engineering guidance
diff --git a/README.md b/README.md
index ae3f0f20d..ab16fee2c 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,8 @@ releases. Pin the version you integrate.
| `switchyard-runner` | **Alpha** | Running configured routes inside another runtime, such as NeMo Relay. | Integration work and supervised pilots. |
| `switchyard-server` | **Demo** | A standalone OpenAI- and Anthropic-compatible proxy, including a local Codex service. | Demos, evaluation, and personal use on single-user machines. Not for production. |
+![Switchyard Components](docs/assets/switchyard-components.png)
+
## Community and license
[Report an issue](https://github.com/NVIDIA-NeMo/Switchyard/issues) · [Contribute](CONTRIBUTING.md) · [Code of conduct](CODE_OF_CONDUCT.md)
diff --git a/docs/assets/switchyard-components.png b/docs/assets/switchyard-components.png
new file mode 100644
index 000000000..c3fa246d6
Binary files /dev/null and b/docs/assets/switchyard-components.png differ