Skip to content

Add Jetpack Compose guide for Ably Chat integration. #2622

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
Merged
merged 5 commits into from
Jun 13, 2025
Merged

Add Jetpack Compose guide for Ably Chat integration. #2622

merged 5 commits into from
Jun 13, 2025

Conversation

ttypic
Copy link
Contributor

@ttypic ttypic commented May 21, 2025 •
edited
Loading

This guide outlines setup and usage of Ably Chat in an Android app built with Jetpack Compose. It covers key features such as realtime messaging, presence, reactions, message history, and resource management.

Description

Checklist

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 21, 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch 2 times, most recently from 428a22c to 4bf519f Compare May 21, 2025 13:57
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin branch from 1a14989 to ab4a0ae Compare May 21, 2025 14:01
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from 4bf519f to e614cec Compare May 21, 2025 14:03
@ttypic ttypic requested review from AndyTWF and m-hulbert May 21, 2025 14:08
@ttypic ttypic changed the base branch from ECO-5270/chat-start-kotlin to main May 21, 2025 16:00
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from e614cec to fd154ff Compare May 21, 2025 16:01
@ttypic ttypic mentioned this pull request May 21, 2025
Closed
3 tasks
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from fd154ff to 44984bf Compare May 21, 2025 16:12
@m-hulbert m-hulbert temporarily deployed to ably-docs-eco-5270-chat-sbgxjn May 22, 2025 09:01 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-eco-5270-chat-2gglde May 22, 2025 09:06 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-eco-5270-chat-2gglde May 22, 2025 11:20 Inactive
AndyTWF
AndyTWF reviewed May 22, 2025
View reviewed changes
Copy link
Contributor

@AndyTWF AndyTWF left a comment

Choose a reason for hiding this comment

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

I've reviewed up to Step 6, but I can't get past that point as the app crashes, so will leave my review here for now :)

src/pages/docs/chat/getting-started/kotlin.mdx Outdated

## Step 1: Setting up Ably <a id="step-1"/>

Replace the contents of your `MainActivity.kt` file with the following code to set up the Ably client:
Copy link
Contributor

Choose a reason for hiding this comment

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

Definitely needs an explicit callout here to add your key (should we encourage good practice by setting it in build config?)

Defintely worth calling out that we're using a key but in prod you'd use tokens

@ttypic ttypic requested a review from AndyTWF May 27, 2025 10:02
AndyTWF
AndyTWF reviewed Jun 4, 2025
View reviewed changes
Copy link
Contributor

@AndyTWF AndyTWF left a comment

Choose a reason for hiding this comment

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

Starting to take shape! Just a few final comments :)

@ttypic ttypic requested a review from AndyTWF June 10, 2025 12:03
AndyTWF
AndyTWF reviewed Jun 10, 2025
View reviewed changes
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch 2 times, most recently from 7bd70ce to 1beea52 Compare June 10, 2025 14:51
@ttypic ttypic force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from 1beea52 to 533029f Compare June 11, 2025 08:08
@GregHolmes GregHolmes force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from 533029f to 96c927b Compare June 11, 2025 11:48
ttypic and others added 5 commits June 13, 2025 09:20
@ttypic @GregHolmes
Add Jetpack Compose guide for Ably Chat integration.
678b1cb 
This guide outlines setup and usage of Ably Chat in an Android app built with Jetpack Compose. It covers key features such as realtime messaging, presence, reactions, message history, and resource management.
@AndyTWF @GregHolmes
chat: add kotlin getting started to nav
f42cc05
@ttypic @GregHolmes
Fix review comments:
9449f49 
- Updated import list, so all imports for the `ChatBox` component are predefined
- Fixed typos
- Improved app layout
@ttypic @GregHolmes
Fix review comments:
1f56890 
- put utility function creation at the beginning of "update step"
- explain where we add edit button
@GregHolmes
Add sign up URL to kotlin getting started and improved readability of…
bf8cd0e 
… a step
@GregHolmes GregHolmes force-pushed the ECO-5270/chat-start-kotlin-jetpack branch from f496c54 to bf8cd0e Compare June 13, 2025 08:20
@GregHolmes GregHolmes merged commit 81641cf into main Jun 13, 2025
6 checks passed
@GregHolmes GregHolmes deleted the ECO-5270/chat-start-kotlin-jetpack branch June 13, 2025 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GregHolmes GregHolmes GregHolmes approved these changes

@AndyTWF AndyTWF AndyTWF approved these changes

@m-hulbert m-hulbert Awaiting requested review from m-hulbert

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ttypic @GregHolmes @AndyTWF @m-hulbert