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.

Redirects: General FAQ

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

Jira: EDU-2071

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

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

@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
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