docs: close RC1 reference gaps for [targets] and switchyard-server options - #295
Merged
Merged
Conversation
Signed-off-by: Eric Liu <zengyuanl@nvidia.com>
Signed-off-by: Eric Liu <zengyuanl@nvidia.com>
|
WalkthroughThe documentation adds two server CLI options and clarifies TOML deployment requirements. It also adds a noop deployment example with an empty ChangesDocumentation references
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
elyasmnvidian
approved these changes
Aug 5, 2026
linj-glitch
approved these changes
Aug 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two gaps in the published reference docs, found by a step-by-step first-time-user pass over the
v0.2.0-rc.1documentation.docs/reference/toml_schema.md— the page describesnoopas a zero-upstream local smoke test, but a noop-only config is rejected withmissing field `targets`. The page now states thatschema_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 thenoopsection.This matches
ServerConfig(crates/switchyard-server/src/config.rs), wherellm_clientscarries#[serde(default)]andtargetsdoes not.docs/cli_reference.md— theswitchyard-serveroptions table was missing two shipped options:--routing-log-file PATHand--shutdown-timeout(default30s). Both are added in--helporder, so the table now matches the binary.