Skip to content

[DX-631] Pub/Sub JavaScript SDK API references (realtime interface) - #3400

Open
m-hulbert wants to merge 27 commits into
mainfrom
dx-631-pubsub-js
Open

[DX-631] Pub/Sub JavaScript SDK API references (realtime interface)#3400
m-hulbert wants to merge 27 commits into
mainfrom
dx-631-pubsub-js

Conversation

@m-hulbert

Copy link
Copy Markdown
Contributor

Description

This PR proposes a new format for the Pub/Sub JavaScript SDK (realtime interface) API references.

It uses the new components and design for API references introduced for the Chat API refs, updates the content to the latest SDK version (2.22.1) and tidies up anything that was legacy.

It also introduces a slightly new IA to better group like APIs, and ensures a better blend between the actual interface names used by the SDK (e.g. RealtimeChannel) and the concepts themselves (e.g. 'Channels').

For now, this doesn't update any links or remove the existing API references. This will follow once REST is complete for JavaScript, as we'll need to update the query param behaviour for API reference links. 1

Checklist

@m-hulbert m-hulbert self-assigned this Jun 9, 2026
@m-hulbert m-hulbert added the review-app Create a Heroku review app label Jun 9, 2026
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

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.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: cb4b01d7-a94e-4c89-b5b9-a8ca87ce74ce

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
  • Commit unit tests in branch dx-631-pubsub-js

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.

@ably-ci
ably-ci temporarily deployed to ably-docs-dx-631-pubsub-ww6bte June 9, 2026 08:38 Inactive
@ably-ci
ably-ci temporarily deployed to ably-docs-dx-631-pubsub-ww6bte June 9, 2026 08:43 Inactive
@m-hulbert
m-hulbert marked this pull request as ready for review June 9, 2026 09:33
Comment thread src/pages/docs/pub-sub/api/javascript/realtime/auth.mdx
Comment thread src/pages/docs/pub-sub/api/javascript/realtime/auth.mdx Outdated
Comment thread src/pages/docs/pub-sub/api/javascript/realtime/auth.mdx Outdated
Comment thread src/pages/docs/pub-sub/api/javascript/realtime/realtime-channel.mdx
@m-hulbert
m-hulbert requested a review from ttypic June 9, 2026 10:33

@ttypic ttypic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

m-hulbert and others added 17 commits July 27, 2026 09:19
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

4 participants