{{ message }}
Repository navigation
docs: align async respond examples with main - #1057
Closed
nachiketb-nvidia wants to merge 1 commit into
Closed
nachiketb-nvidia wants to merge 1 commit into
nachiketb-nvidia wants to merge 1 commit into
Conversation
Signed-off-by: nachiketb <nachiketb@nvidia.com>
Contributor
ayushag-nv
reviewed
Oct 20, 2026
| futures = "0.3" | ||
| switchyard-libsy = { git = "https://github.com/NVIDIA-NeMo/Switchyard.git", tag = "v0.3.0" } | ||
| switchyard-protocol = { git = "https://github.com/NVIDIA-NeMo/Switchyard.git", tag = "v0.3.0" } | ||
| switchyard-libsy = { git = "https://github.com/NVIDIA-NeMo/Switchyard.git", branch = "main" } |
Contributor
There was a problem hiding this comment.
do we want to tag to main or latest release ? For each release branch we have to change this to the release tag then ?
Contributor
Author
There was a problem hiding this comment.
I think README and Quickstart should be based off latest main right?
Contributor
Author
There was a problem hiding this comment.
at least when its on main, for release docs, this should be 0.3.0
Contributor
There was a problem hiding this comment.
so we change in each release branch or something ?
Contributor
Author
There was a problem hiding this comment.
probably, maybe we can automate this somehow
Contributor
Author
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.

Why
The docs show the async
respondAPI introduced after v0.3.0, but their dependency blocks still select the v0.3.0 Git tag. Copying the Rust example produces E0308 and E0277. The published Python wheel also has the old synchronous API.What
mainbranch for libsy and protocol in Getting Started, the libsy README, and the Rust API reference.respond.Three documentation files: 18 additions / 8 deletions. No runtime changes, new tests, or quickstart restructuring. This is separate from the library-first onboarding work.
Validation
5415db205and passed.respondline with a mock judge call. The handler ran and the expected target was selected.git diff --checkpassed.No live provider calls or release publication.
Summary by CodeRabbit