docs: add channel-level echo param documentation#3244
docs: add channel-level echo param documentation#3244mattheworiordan wants to merge 3 commits intomainfrom
Conversation
New echo.mdx page covering why echo is the default, per-channel suppression use cases, multi-language code examples, and interaction with connection-level echoMessages. Updates channel options overview, API types reference, advanced pub-sub cross-reference, and sidebar nav.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mattheworiordan
requested review from
Copilot,
m-hulbert,
paddybyers and
rainbowFi
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new per-channel echo channel parameter, which allows clients to suppress echoing of their own messages on a channel-by-channel basis, complementing the existing connection-level echoMessages option.
Changes:
- Adds a new dedicated page (
channels/options/echo.mdx) explaining theechochannel param with use cases, multi-language code examples, and interaction table withechoMessages. - Adds an Echo section to the channel options overview page and cross-references in the advanced pub-sub and API types reference pages.
- Adds Echo to the sidebar navigation in the correct alphabetical position.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/pages/docs/channels/options/echo.mdx |
New dedicated page explaining the echo channel param |
src/pages/docs/channels/options/index.mdx |
Updated intro and added Echo section with code examples |
src/pages/docs/pub-sub/advanced.mdx |
Added cross-reference to per-channel echo suppression |
src/pages/docs/api/realtime-sdk/types.mdx |
Updated params description with links to all supported param pages |
src/data/nav/pubsub.ts |
Added Echo nav entry under Channel options |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <Aside data-type='note'> | ||
| <p>The <code>echo</code> channel param only affects messages. Presence events are always delivered regardless of the echo setting.</p> | ||
| </Aside> |
There was a problem hiding this comment.
The <Aside> component at line 105 is missing its closing </Aside> tag. Every other <Aside> usage in this documentation (e.g., in rewind.mdx, encryption.mdx, index.mdx) uses an explicit closing </Aside> tag. Without it, the MDX rendering will likely break or produce incorrect output for this component and potentially the rest of the page.
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Pushed a small fixup but LGTM after a rebase otherwise.
Summary
Adds documentation for per-channel echo suppression via the
echochannel param:channels/options/echo.mdx— explains why echo exists (consistent state rendering), when to suppress it (streaming data, AI Transport, RPC, mixed workloads), multi-language code examples, and interaction with connection-levelechoMessagesWhy
Echo control has been connection-level only (
echoMessages: false) since the beginning. This forces all channels on a connection to share the same echo behavior, which is inadequate for:echoMessages: false(token streaming, citations, tool calls, etc.)echoMessages: falseat the connection levelThis has been a long-standing gap. Channel-level echo gives customers finer control without any backwards compatibility concerns.
Related PRs
Test plan