Skip to content

Chat: Update chat docs for single channel changes #2524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: integration/chat-single-channel
Choose a base branch
from
Open

Chat: Update chat docs for single channel changes #2524

wants to merge 5 commits into from

Conversation

splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Apr 11, 2025 •
edited by jira bot
Loading

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

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 11, 2025

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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@splindsay-92 splindsay-92 marked this pull request as ready for review April 11, 2025 09:50
@m-hulbert
Copy link
Contributor

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

@splindsay-92 splindsay-92 requested a review from AndyTWF April 15, 2025 09:46
@splindsay-92
Copy link
Contributor Author

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
m-hulbert reviewed Apr 23, 2025
View reviewed changes
Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of small comments / questions 🙂

content/chat/rooms/index.textile
Comment on lines +16 to +21
It is important to note that each room is backed by a single Ably Pub/Sub channel.
The channel name is the same as the room ID with an appended suffix of @::$chat@ (e.g @some-room-id::$chat@). In most cases, you will not need to worry about this, as the Chat SDK handles the channel creation and management for you and capabilities can be configured at the room level.

<aside data-type='note'>
<p>You may need to be aware of this when using some integrations with Ably, such as the "Pulsar":https://ably.com/docs/integrations/streaming/pulsar#creating-pulsar-rule connectors, or if you are operating in an environment where a Chat SDK is not available.</p>
</aside>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest we drop the info from the note and re-order this a little. We've said it's an important thing to note/understand, so I think we should follow that with why it's important to know before explaining the relationship.

content/chat/rooms/index.textile

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :)

content/chat/rooms/occupancy.textile
@@ -12,7 +12,7 @@ languages:
Occupancy enables you to view the number of users currently online in a room. This feature can be used to display user counts to highlight popular, or trending chat rooms.

<aside data-type='note'>
<p>Occupancy needs to be "enabled":/docs/chat/rooms#create when creating or retrieving a room.</p>
<p>As Occupancy incurs additional costs, it is disabled by default and needs to be "enabled":/docs/chat/rooms#create when creating or retrieving a room.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we provide some additional context about the # of messages occupancy can produce so that the extra message costs can be considered?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-hulbert m-hulbert m-hulbert left review comments

@GregHolmes GregHolmes Awaiting requested review from GregHolmes

@AndyTWF AndyTWF Awaiting requested review from AndyTWF

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@splindsay-92 @m-hulbert