Skip to content

[DX-627] Adds an API reference for Chat in JavaScript#3212

Merged
m-hulbert merged 13 commits intomainfrom
dx-627-chat-js-api
Mar 2, 2026
Merged

[DX-627] Adds an API reference for Chat in JavaScript#3212
m-hulbert merged 13 commits intomainfrom
dx-627-chat-js-api

Conversation

@m-hulbert
Copy link
Copy Markdown
Contributor

Description

This PR adds an API reference for Chat in JavaScript/TypeScript using the new NestedTable and MethodSignature components. It should have parity with the TypeDoc references.

There is 1 commit per file, however I haven't yet updated the references in the conceptual content to point to these references yet to keep this PR smaller for review feedback. I will add that as a separate PR or final commit once we are happy with this content.

Checklist

@m-hulbert m-hulbert self-assigned this Feb 17, 2026
@m-hulbert m-hulbert added the review-app Create a Heroku review app label Feb 17, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 17, 2026

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.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dx-627-chat-js-api

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@ably-ci ably-ci temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 17, 2026 17:44 Inactive
Copy link
Copy Markdown
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

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

Mostly small issues, but there are a couple of API inconsistencies that need to be addressed :)

Comment thread src/pages/docs/chat/api/javascript/chat-client.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/message-reactions.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/presence.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/rooms.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/chat-client.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/messages.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/message-reactions.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/message-reactions.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/message-reactions.mdx Outdated
Comment thread src/pages/docs/chat/api/javascript/presence.mdx Outdated
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 09:33 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 10:15 Inactive
@m-hulbert m-hulbert temporarily deployed to ably-docs-dx-627-chat-j-1akazo February 20, 2026 12:20 Inactive
Copy link
Copy Markdown
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

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

Nice, LGTM.

@m-hulbert m-hulbert force-pushed the dx-627-chat-js-api branch from 5a17f8d to 729d5df Compare March 2, 2026 10:11
@m-hulbert m-hulbert force-pushed the dx-627-chat-js-api branch from 729d5df to 8ae00d2 Compare March 2, 2026 11:22
@m-hulbert m-hulbert merged commit 4009afd into main Mar 2, 2026
7 checks passed
@m-hulbert m-hulbert deleted the dx-627-chat-js-api branch March 2, 2026 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants