Skip to content

Conversation

franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Sep 11, 2025

This PR removes the general FAQ section and adds comprehensive documentation improvements across multiple areas of the platform:

How can I set up different environments in Ably?

  • Added environments section explaining app sandboxing.
  • Added warning about shared account limits across environments.

Is there a limit to the length of the ClientId or Channel name?

  • Added client identifier limits section.
    • Clarified that clientId counts toward message size limits
  • Added channel identifier limits section

How can I subscribe to messages using REST only SDKs?

  • Added section on implementing realtime features with REST-only SDKs.
    • Documented MQTT protocol adapter.
    • Added PubNub protocol adapter.
    • Included Ably queues.

CSP Rejection to internet-up.ably-realtime.com/is-the-internet-up.txt

  • Enhanced error code 80014
    • Added CSP policy requirements for the internet connectivity testing endpoint.
    • Explained how blocking this resource affects fallback host usage.

Are the Message and Data Transfer Limits Enforced Separately?

  • Clarified that message count limits and data transfer limits are enforced separately.
  • Added explanation that exceeding one limit does not affect the other

Should I reduce the REST publish timeout?

  • Added comprehensive REST publish timeouts section.
  • Explained why short timeouts can be problematic.
  • Documented the reasoning behind the default 10-second timeout.
  • Provided guidance on when timeout adjustments are appropriate.

Do you have a terms of service?

How can I alert a user to subscribe to a channel?

  • Added comprehensive direct messaging patterns documentation.
  • Covered notification channels architecture for alerting users to new conversations.

Addresses reviewer feedback

  • basics/index.mdx - @m-hulbert: "I think this content is unnecessary and covered elsewhere on this page." - Removed the "Implementing realtime features with REST-only SDKs" section - Content was unnecessary and covered elsewhere on the page

  • chat/patterns/direct-messaging - @m-hulbert: "Let's pull this out and treat this as a separate piece of work."

  • Completely removed the 86-line file .

  • To be treated as separate work outside this PR.

  • `errors/codes.mdx - @m-hulbert: "I don't think this is right place for this piece of info. Let's deal with this one outside of this PR too." - Removed CSP policy details for internet-up.ably-realtime.com - Content will be addressed in a different location outside this PR

  • 4. Client and channel identifier limits (limits.mdx:92-98) - @m-hulbert: "I think this is already covered here" and "I think this is unnecessary since we already cover this at the point you create a channel." - Removed both "Client identifier limits" and "Channel identifier limits" sections - Information is already covered elsewhere in the documentation

  • 5. Platform usage note (platform/index.mdx:46-48) - @m-hulbert: "I think we might need to make a bigger thing out of this - let's deal with this one outside this PR." - Removed aside about Ably being designed for messaging, not media streaming - Will be expanded into a bigger feature outside this PR

  • 6. REST publish timeouts section (pub-sub/index.mdx:440-460) - @m-hulbert: "I don't think this should be on a page about basic Pub/Sub. Also, whilst it makes sense to condense the info from the original article, I think this is missing some key context and info in certain sections." - Removed detailed timeout guidance from basic Pub/Sub page - Content was too advanced for the basic documentation page

  • 7. Terms FAQ file and navigation (platform/pricing/terms-faqs.mdx + platform.ts:136-139) - @m-hulbert: "Where have the FAQs come from in this fixup? I don't think we should be trying to parse or shorten these at all. Let's add the question to the pricing FAQ and link out." - Removed the 61-line legal terms FAQ file - Removed corresponding navigation menu entry - Content will be handled differently (add to pricing FAQ and link out)

  • 8. Added limits page link (platform/account/app/index.mdx:38) - @m-hulbert: "Quick link to the limits page here?" - Enhanced the account limits warning with a direct link to /docs/platform/pricing/limits


---

Redirects:  [General FAQ](https://docs.google.com/document/d/1LP6a4xk_qQg1GpGh9hBWlooJWBX6BtVVigZRT0Tyf_I/edit?tab=t.mg2vyit68i56#heading=h.6r6v0ck6hlb0)

FAQ: https://faqs.ably.com/general

Jira: [EDU-2071](https://ably.atlassian.net/browse/EDU-2071)

[EDU-2071]: https://ably.atlassian.net/browse/EDU-2071?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Copy link

coderabbitai bot commented Sep 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.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2071-remove-the-general-section-of-fa-qs

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.

@franrob-projects franrob-projects changed the title Edu 2071 remove the general section of fa qs Edu 2071 remove the general section of faqs Sep 11, 2025
@franrob-projects franrob-projects added the review-app Create a Heroku review app label Sep 11, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-edu-2071-remo-krvjxm September 11, 2025 14:09 Inactive
@franrob-projects franrob-projects marked this pull request as ready for review September 11, 2025 14:09
@@ -0,0 +1,138 @@
---
title: Terms of Service
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it's correct to repeat these from the website, as we're just duplicating the content. If we think it's important to still reference them (maybe look at the relative popularity of the FAQ) then it should be an FAQ that links out to the website.

You could also test 'Ask Ably' and see what that currently picks up (I suspect it will just land them on the original terms of serivce, rather than going via the FAQs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Where have the FAQs come from in this fixup? I don't think we should be trying to parse or shorten these at all.

Let's add the question to the pricing FAQ and link out.

@franrob-projects franrob-projects force-pushed the EDU-2071-remove-the-general-section-of-fa-qs branch from 2e92099 to d6400bb Compare September 19, 2025 11:34
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.

  • I think this needs to be retained in the short term.
  • I think this is covered to some extent, but we should also be covering some of this info on the history page and linking back to the explanation to CGO.

```
</Code>

### REST publish timeouts <a id="rest-timeouts"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this should be on a page about basic Pub/Sub.

Also, whilst it makes sense to condense the info from the original article, I think this is missing some key context and info in certain sections.

@@ -0,0 +1,138 @@
---
title: Terms of Service
Copy link
Contributor

Choose a reason for hiding this comment

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

Where have the FAQs come from in this fixup? I don't think we should be trying to parse or shorten these at all.

Let's add the question to the pricing FAQ and link out.

@franrob-projects
Copy link
Contributor Author

franrob-projects commented Oct 1, 2025

@m-hulbert Please see the update in the updated commit comments in the PR description at the top for -> Addresses reviewer feedback

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