docs(readme): restructure around three integration paths

[itayzit]

What

Restructures the README around how people actually adopt Switchyard, in the
order they should reach for it: use it inside a gateway you already run →
integrate it into a gateway you build → run the standalone proxy.

• What is Switchyard opens with the benchmark chart, then three sections:
  Use Switchyard (NeMo Relay, LiteLLM), Integrate Switchyard into your
  gateway or harness (pip install nemo-switchyard, then the guide), and Run
  Switchyard as a standalone proxy. Each has a diagram; all three share one
  shape and differ only in what box Switchyard sits inside. The Switchyard node
  is NVIDIA green in every diagram.
• Maturity → Components. The warning callout is replaced by a table of
  stability, intended use, and adoption guidance per crate — beta / alpha / demo.
• Get Started is three self-contained paths — Relay, Library, Proxy — each
  stating where you start and what you finish with. Path 2 is now built around
  a verified Python example: the run_stream loop over CallModel / Done,
  executed against the real switchyard.libsy bindings before it went in.
• Routing algorithm names follow the Slack thread: Capability, Stage,
  Capability + Stage, Escalation, Advisor Gate, Sub-Agent-Aware, Custom, Random.
• No links to docs/getting_started.md. Chart labels read "Switchyard:"
  rather than "SY:"; a footnote states the cost basis.

Why

The library is the primary way we want Switchyard adopted, and the README led
with the proxy. It also had no working example for the embed path in any
language, and every install path started mid-story.

Notes for reviewers

Read the rendered page, not the diff — it is a rewrite. The mermaid diagrams
and the chart only render on GitHub. Flip your theme once: the green node is
verified to survive mermaid's dark theme, but worth one look.

Judgement calls worth a second opinion:

• Path 2's Python loop is the only embed example in the repository. I
  grepped every crate README and docs/ page for Step.CallModel / Step.Done
  — zero hits. It should probably also live in crates/libsy/README.md; that is
  a follow-up, not this PR.
• docs/getting_started.md is now unreferenced by the README but still
  exists. Deleting it is an 11-file change that also removes
  tests/getting_started/ and a CI workflow, so it is left for its own PR. Note
  that test asserts ## Server Path before ## Library Path — the opposite of
  the order adopted here.
• The proxy diagram has no subgraph, deliberately. The other two are boxed
  inside something you already run; the proxy is its own process.
• The chart footnote says "ISP token cost" as requested. Most readers will
  parse ISP as Internet Service Provider; spelling out "inference-provider" may
  be worth it.

🤖 Generated with Claude Code

[coderabbitai]

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: 15af9587-ab69-4dfe-80eb-10abccf2496d

📥 Commits

Reviewing files that changed from the base of the PR and between bb07f99 and a9a34d1.

📒 Files selected for processing (1)

• README.md

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

---

Walkthrough

Changes

README onboarding

Layer / File(s)	Summary
Usage paths README.md	The introduction and Get Started section now describe separate library, Relay plugin, and proxy paths.
Proxy and agent instructions README.md	The proxy walkthrough links to server configuration and presents coding-agent setup as step 5.
Content organization README.md	The former standalone library section and Getting Started index entry were removed. Benchmark content moved to Benchmark Provenance.

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

Merge Risk: 🔵 Low · up to a9a34

The reorganized onboarding is broadly mergeable, but the introductory proxy instructions should confirm the default network exposure and authentication expectations to avoid unsafe deployment assumptions.

Poem

A rabbit reads the paths anew
Three trails guide what users do
Relay hops beside the proxy bright
Library steps are clear and light
Benchmarks rest in their proper burrow

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: restructuring the README around three integration paths.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

---

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