Rewind param: stop making the non-ably-sdk fallback method the first thing we tell people about#3334
Rewind param: stop making the non-ably-sdk fallback method the first thing we tell people about#3334SimonWoolf wants to merge 3 commits intomainfrom
Conversation
|
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 |
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Small suggestion to make the link inline, but LGTM otherwise.
| </Code> | ||
|
|
||
| <Aside data-type="note"> | ||
| If using [MQTT](/docs/protocols/mqtt) or [SSE](/docs/protocols/sse), see [Channel options without Ably SDK support](/docs/channels/options#other-sdks) for how to specify a rewind param. |
There was a problem hiding this comment.
| If using [MQTT](/docs/protocols/mqtt) or [SSE](/docs/protocols/sse), see [Channel options without Ably SDK support](/docs/channels/options#other-sdks) for how to specify a rewind param. | |
| If using [MQTT](/docs/protocols/mqtt) or [SSE](/docs/protocols/sse), you can [specify channel params](/docs/channels/options#other-sdks) as a query string. |
…thing we tell people about It doesn't make sense to start out by saying "rewind can _also_ be set by..." and then giving the MQTT/SSE fallback method when we haven't told people the actual, real method yet. Nor to have that as a top-level paragraph followed by an inset note explaining when you should use that method, it's absolutely not intuitive that the inset note is meant to qualify the previous not-inset paragraph
channel options: https://ably.com/docs/api/realtime-sdk/types#channel-options channel params: possible values for the channelOptions.params map
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 participants
It doesn't make any sense to start out by saying "rewind can also be set by..." and then the MQTT/SSE fallback method when we haven't told anyone the actual, main method that they should use with ably SDKs yet. Nor to have that as a top-level paragraph followed by an inset note explaining when you should use that method (for mqtt and sse), it's not at all obvious that the inset note is meant to tell you when to use the previous not-inset paragraph
I think this was a regression from #1937
also fix a bunch of places on that page where we call it a channel option not a channel param