[DX-955] Add use-case based SDK references across Pub/Sub pages#3340
Draft
[DX-955] Add use-case based SDK references across Pub/Sub pages#3340
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 |
sacOO7
changed the title
sacOO7
changed the title
There was a problem hiding this comment.
Pull request overview
Updates Ably documentation to steer developers toward purpose-built SDKs (Chat/Spaces) for common realtime features, while positioning Pub/Sub as the underlying primitive for custom use cases and adding/fixing cross-links for smoother navigation.
Changes:
- Adds Chat SDK / Spaces SDK cross-references and guidance asides across Pub/Sub, Presence/Occupancy, Messages, and Spaces docs.
- Fixes broken anchors/links and converts legacy Textile-style links to standard MDX link syntax.
- Standardizes example channel naming (e.g.,
chatroom→my-channel) and replaces placeholder API keys with template variables.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/pages/docs/spaces/index.mdx | Reframes “enhancements” to point to purpose-built SDKs and product guidance. |
| src/pages/docs/pub-sub/guides/data-streaming.mdx | Adds Chat SDK guidance aside, fixes broken stats anchor, and updates example API key placeholders. |
| src/pages/docs/pub-sub/guides/dashboards-and-visualizations.mdx | Fixes channel attach/detach links, updates persistence anchor, templatises credentials, and adds SDK guidance asides. |
| src/pages/docs/pub-sub/advanced.mdx | Renames example channel identifiers and wraps subscription filters notice in a consistent public preview aside; adds an anchor for headers section. |
| src/pages/docs/presence-occupancy/presence.mdx | Adds Chat/Spaces guidance, updates examples to use neutral channel names, and adds an avatar stack cross-link. |
| src/pages/docs/presence-occupancy/index.mdx | Adds Chat SDK guidance note and links “chat application” to Chat docs. |
| src/pages/docs/messages/updates-deletes.mdx | Adds guidance to prefer Chat SDK editing/moderation APIs for chat contexts. |
| src/pages/docs/messages/annotations.mdx | Adds Chat SDK cross-references and introduces an “interactions” anchor; clarifies intent for non-chat Pub/Sub use. |
| src/pages/docs/faq/push-faqs.mdx | Fixes broken publish anchors by pointing to Pub/Sub publish section. |
| src/pages/docs/chat/rooms/message-reactions.mdx | Fixes “PubSub” naming to “Pub/Sub” for consistency. |
| src/pages/docs/channels/states.mdx | Updates channel name examples to avoid implying Pub/Sub channels are “chat rooms.” |
| src/pages/docs/channels/options/rewind.mdx | Adds pointer to Chat SDK history for chat-room-style history use cases. |
| src/pages/docs/channels/options/echo.mdx | Adds Chat SDK link for chat application example reference. |
| src/pages/docs/channels/index.mdx | Converts legacy Textile links to MDX and updates persistence link target. |
| src/pages/docs/basics/index.mdx | Positions presence as the underlying primitive for Spaces/Chat features; links to product guidance. |
| src/pages/docs/auth/token/jwt.mdx | Updates JWT examples to use neutral channel names instead of chat-specific ones. |
| src/pages/docs/auth/identified-clients.mdx | Links chat application example reference to Chat docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
646
to
649
| { | ||
| "chatPresence": ["presence"], | ||
| "chat": ["publish", "history", "subscribe"], | ||
| "my-presence-channel": ["presence"], | ||
| "my-channel": ["publish", "history", "subscribe"], | ||
| } |
Comment on lines
657
to
660
| { | ||
| "chatPresence": ["presence", "subscribe"], | ||
| "chat": ["publish", "history", "subscribe"], | ||
| "my-presence-channel": ["presence", "subscribe"], | ||
| "my-channel": ["publish", "history", "subscribe"], | ||
| } |
| | Server-side batching | If enabled, messages are grouped into batches before being sent to subscribers. [Server-side batching](/docs/messages/batch#server-side) reduces the overall message count, lowers costs, and mitigates the risk of hitting rate limits during high-throughput scenarios. | | ||
| | Message conflation | If enabled, messages are aggregated over a set period of time and evaluated against a conflation key. All but the latest message for each conflation key value will be discarded, and the resulting message, or messages, will be delivered to subscribers as a single batch once the period of time elapses. [Message conflation](/docs/messages#conflation) reduces costs in high-throughput scenarios by removing redundant and outdated messages. | | ||
| | Message annotations, updates, deletes, and appends | If enabled, allows message "annotations":/docs/messages/annotations to be used, as well as updates, deletes, and appends to be published to messages. Note that these features are currently in public preview. When this feature is enabled, messages will be "persisted":/docs/storage-history/storage#all-message-persistence (necessary in order from them later be annotated or updated), and "continuous history":/docs/storage-history/history#continuous-history features will not work. | ||
| | Message annotations, updates, deletes, and appends | If enabled, allows message [annotations](/docs/messages/annotations) to be used, as well as updates, deletes, and appends to be published to messages. Note that these features are currently in public preview. When this feature is enabled, messages will be [persisted](/docs/storage-history/storage#all-message-persistence) (necessary in order for them later be annotated or updated), and [continuous history](/docs/storage-history/history#continuous-history) features will not work. |
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.
Changes
SDK cross-references (prevent misguided implementations):
basics, data streaming guide, and dashboards guide pages
to the appropriate SDK docs
Broken links fixed:
/docs/channels#publish→/docs/pub-sub#publishin push FAQs (2 instances)/docs/storage-history/storage#persistence→/docs/storage-history/storage#all-message-persistencein dashboards guide
/docs/metadata-stats/stats#live→/docs/metadata-stats/stats#app-metain data streaming guide"text":/path) → MDX links ([text](/path)) in channels index, plus typo fixNaming and consistency:
chatroom/private:chatroomchannel names withmy-channel/private:my-channelacrosschannel states (~20 instances) and Pub/Sub advanced (~20 instances) to avoid implying Pub/Sub
channels are for building chat
your-api-key,YOUR_API_KEY_NAME) with template variables(
{{API_KEY}},{{API_KEY_NAME}},{{API_KEY_SECRET}}) in both Pub/Sub guidesStale notice:
<Aside data-type='public-preview'>block for consistency