-
Notifications
You must be signed in to change notification settings - Fork 45
Edu 2073 Remove Realtime API faqs #2836
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.
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
base: main
Are you sure you want to change the base?
Edu 2073 Remove Realtime API faqs #2836
Conversation
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests
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. 🧪 Early access (Sonnet 4.5): enabledWe are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. Note:
Comment |
873d23f
to
2e93f88
Compare
…the Failed, Disconnected or Suspended states?
… multiple SDK instances for the same origin?
…ntentScript scope in a Chrome extension in Chrome 73+
…ar to timeout immediately
…o without disconnecting?
…uting: /usr/bin/git ls-remote -h -t
2f3b65f
to
ac17e04
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive FAQ documentation to the Ably docs covering common issues with the Realtime API and client libraries. The purpose is to migrate and expand frequently asked questions from external sources into the main documentation.
- Adds troubleshooting guides for connection issues, SSL certificates, and duplicate messages
- Documents authentication behavior including token renewal and dynamic access control
- Provides configuration guidance for browser environments and multiple SDK instances
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
src/pages/docs/platform/pricing/faqs.mdx | Adds FAQ about high concurrent connection counts with troubleshooting steps |
src/pages/docs/platform/errors/index.mdx | Adds monitoring best practices and SSL certificate troubleshooting |
src/pages/docs/getting-started/setup.mdx | Minor formatting - adds blank lines after code blocks |
src/pages/docs/connect/states.mdx | Documents system disconnections and enhanced connection state descriptions |
src/pages/docs/connect/index.mdx | Adds browser page unload behavior documentation |
src/pages/docs/channels/index.mdx | Adds troubleshooting section for duplicate message issues |
src/pages/docs/auth/token.mdx | Documents token renewal timing, TTL limits, and dynamic access control |
src/pages/docs/auth/identified-clients.mdx | Documents clientId immutability rules |
content/partials/types/_realtime_client_options.textile | Adds realtimeRequestTimeout configuration option |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ably-js page unload behaviour
How to adjust the realtimeRequestTimeout to a higher value (on ably-js)
Why is my Ably realtime connection sometimes disconnecting and reconnecting?
Should I monitor for non-2xx network requests to identify issues?
Will I receive an error if a client publishes with the connection in the Failed, Disconnected or Suspended states?
Can I change my connection's clientId after connecting?
How can I use ably-js session recovery over a page reload when I have multiple SDK instances for the same origin?
Why am I seeing every message multiple times?
CORB blocked cross-origin response error when using ably-js from a contentScript scope in a Chrome extension in Chrome 73+
Why are my concurrent connection counts higher than expected?
SSL certificate issues communicating with Ably
ClassNotFoundException when using Proguard with ably-java
Using ably-js-react native, connection attempts or rest requests appear to timeout immediately
Is it necessary to implement auto-renewal of tokens when using Token Auth?
Is it possible to dynamically change the channels a user has access to without disconnecting?
Do you have a max TTL for tokens?
remove When I try installing ably-js with npm, I get Error while executing: /usr/bin/git ls-remote -h -t
remove https://github.com/ably-forks/msgpack-js.git
Tidy up commit
Redirects: General FAQ
FAQ: https://faqs.ably.com/realtime-api-and-client-libraries
Jira: EDU-2073