-
Notifications
You must be signed in to change notification settings - Fork 45
Edu 2071 remove the general section of faqs #2824
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 2071 remove the general section of faqs #2824
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. Comment |
@@ -0,0 +1,138 @@ | |||
--- | |||
title: Terms of Service |
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.
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).
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.
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.
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.
2e92099
to
d6400bb
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.
src/pages/docs/pub-sub/index.mdx
Outdated
``` | ||
</Code> | ||
|
||
### REST publish timeouts <a id="rest-timeouts"/> |
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.
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 |
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.
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.
@m-hulbert Please see the update in the updated commit comments in the PR description at the top for -> Addresses reviewer feedback |
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?
Is there a limit to the length of the ClientId or Channel name?
How can I subscribe to messages using REST only SDKs?
CSP Rejection to internet-up.ably-realtime.com/is-the-internet-up.txt
Are the Message and Data Transfer Limits Enforced Separately?
Should I reduce the REST publish timeout?
Do you have a terms of service?
How can I alert a user to subscribe to a channel?
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 pagechat/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