Skip to content

docs: close RC1 reference gaps for [targets] and switchyard-server options - #295

Merged
eric-liu-nvidia merged 2 commits into
mainfrom
eric-liu/switch-1198-docs-gaps-rc1
Aug 5, 2026
Merged

docs: close RC1 reference gaps for [targets] and switchyard-server options#295
eric-liu-nvidia merged 2 commits into
mainfrom
eric-liu/switch-1198-docs-gaps-rc1

Conversation

@eric-liu-nvidia

@eric-liu-nvidia eric-liu-nvidia commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Two gaps in the published reference docs, found by a step-by-step first-time-user pass over the v0.2.0-rc.1 documentation.

docs/reference/toml_schema.md — the page describes noop as a zero-upstream local smoke test, but a noop-only config is rejected with missing field `targets` . The page now states that schema_version, [targets], and [routes] must all be present even when a route reaches no upstream, that an empty [targets] table satisfies the requirement, and that [llm_clients] defaults to empty and may be omitted. A minimal noop-only example was added to the noop section.

This matches ServerConfig (crates/switchyard-server/src/config.rs), where llm_clients carries #[serde(default)] and targets does not.

docs/cli_reference.md — the switchyard-server options table was missing two shipped options: --routing-log-file PATH and --shutdown-timeout (default 30s). Both are added in --help order, so the table now matches the binary.

@eric-liu-nvidia
eric-liu-nvidia requested a review from a team as a code owner August 5, 2026 01:44
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

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

Built to branch gh-pages at 2026-08-05 01:45 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The documentation adds two server CLI options and clarifies TOML deployment requirements. It also adds a noop deployment example with an empty [targets] table.

Changes

Documentation references

Layer / File(s) Summary
Server CLI option reference
docs/cli_reference.md
Documents --shutdown-timeout and --routing-log-file.
Deployment schema contract and noop example
docs/reference/toml_schema.md
Documents required tables, optional [llm_clients], and a valid empty-target noop deployment.

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

Poem

A rabbit reads the flags with care,
And finds new timeout notes there.
Empty targets hop into view,
While noop routes guide them through.
TOML now tells the truth—
Documentation grows fresh roots.

🚥 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.
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 summarizes the documentation changes for required [targets] configuration and switchyard-server options.

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

@eric-liu-nvidia
eric-liu-nvidia merged commit e687455 into main Aug 5, 2026
18 checks passed
@eric-liu-nvidia
eric-liu-nvidia deleted the eric-liu/switch-1198-docs-gaps-rc1 branch August 5, 2026 17:36
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.

3 participants