docs(relay): document WebTransport and remaining flags in usage#37
Merged
Conversation
The Usage section only listed -addr/-cert/-key, omitting -webtransport and -webtransport-path (referenced later in the interop section) plus the catalog and per-session cap flags. Round out the flag table to match cmd/relay/main.go. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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
The
cmd/relayREADME's Usage section only documented-addr,-cert, and-key, even though-webtransportand-webtransport-pathare referenced further down in the interop section. This rounds out the flag table to matchcmd/relay/main.go, adding:-webtransport/-webtransport-path-catalog-track-name/-catalog-ttl-max-subscriptions/-max-namespace-requestsThe other
cmdREADMEs (clock,msfdemo,interop-client) were checked and are accurate —clock/msfdemoare QUIC-only with a single-addrflag, andinterop-clientalready documents WebTransport via its relay URL scheme.🤖 Generated with Claude Code