Chat: Update chat docs for single channel changes by splindsay-92 · Pull Request #2524 · ably/docs

splindsay-92 · 2025-04-11T09:48:33Z

Description

CHA-916 and CHA-874

Chat is moving to a single channel, this includes changes to how features are enabled in the Chat SDK.

Highlight chat room<>channel relationship.
Remove feature specific discontinuity handlers.
Add note on occupancy feature's default state and costs.
Remove mention of feature enablement.
Update capability definition.

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-04-11T09:48:40Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

m-hulbert · 2025-04-14T15:51:17Z

Can we update the examples in this PR as well, or did you have that planned for a separate one?

splindsay-92 · 2025-04-15T09:48:08Z

Can we update the examples in this PR as well, or did you have that planned for a separate one?

I think it's worth doing those as separate PR's, we are merging this into an integrations branch first anyway, so I'll make some tickets for that :)

m-hulbert

Couple of small comments / questions 🙂

m-hulbert · 2025-04-23T12:07:04Z

 h2(#create). Create or retrieve a room

-Users send messages to a room and subscribe to the room in order to receive messages. Other features, such as indicating which users are online, or which users are typing are configured as part of a room's options.
+Users send messages to a room and subscribe to the room in order to receive messages. Other features, such as indicating which users are online, or which users are typing can be configured as part of a room's options.


I'm not sure the second sentence is correct here. Isn't typing enabled by default now?

That's correct, I was trying to say here that those features can be configured (e.g. setting the heartbeat interval etc..), but maybe it seems like I'm suggesting they can be turned on/off. I'll reword this a bit :)

Based on the JS changes in 448fc4b..133accc.

m-hulbert

2 small comments that aren't blocking, LGTM.

splindsay-92 added 5 commits April 10, 2025 17:08

Chat: Updated the chat docs for the single room migration

d62366f

Add explanation of Channel-Room relationship in documentation

d59aeac

Add note on occupancy feature's default state and costs

2d52ea2

Add note styling for integration details in chat rooms doc

27eb5d9

Update RoomOption defaults and property references in table

133accc

splindsay-92 marked this pull request as ready for review April 11, 2025 09:50

splindsay-92 requested review from GregHolmes and m-hulbert April 11, 2025 09:50

splindsay-92 requested a review from AndyTWF April 15, 2025 09:46

m-hulbert reviewed Apr 23, 2025

View reviewed changes

lawrence-forooghian and others added 3 commits April 29, 2025 10:52

chat: Update Swift documentation for single channel

6e45ff2

Based on the JS changes in 448fc4b..133accc.

Fixing PR comments

58d28db

Clarify billable message increase

e37e4cf

splindsay-92 requested a review from m-hulbert May 1, 2025 13:17

splindsay-92 force-pushed the integration/chat-single-channel branch 2 times, most recently from adc7024 to 448fc4b Compare May 1, 2025 16:31

m-hulbert approved these changes May 2, 2025

View reviewed changes

Comment thread content/chat/rooms/presence.textile

Comment thread content/chat/rooms/occupancy.textile Outdated

Refactor: Fix blang and <p> closer

cad9e8b

splindsay-92 merged commit 11da147 into integration/chat-single-channel May 6, 2025

splindsay-92 deleted the chat/update-chat-docs-for-single-channel branch May 6, 2025 11:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Chat: Update chat docs for single channel changes#2524

Chat: Update chat docs for single channel changes#2524
splindsay-92 merged 9 commits into
integration/chat-single-channelfrom
chat/update-chat-docs-for-single-channel

splindsay-92 commented Apr 11, 2025 •

edited by atlassian Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 11, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

m-hulbert commented Apr 14, 2025

Uh oh!

splindsay-92 commented Apr 15, 2025

Uh oh!

m-hulbert left a comment

Uh oh!

Uh oh!

m-hulbert Apr 23, 2025

Uh oh!

splindsay-92 Apr 24, 2025

Uh oh!

Uh oh!

m-hulbert left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

splindsay-92 commented Apr 11, 2025 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai Bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

m-hulbert commented Apr 14, 2025

Uh oh!

splindsay-92 commented Apr 15, 2025

Uh oh!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

m-hulbert Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

splindsay-92 Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

splindsay-92 commented Apr 11, 2025 •

edited by atlassian Bot

Loading

coderabbitai Bot commented Apr 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)