Skip to content

Conversation

GregHolmes
Copy link
Contributor

Description

This PR:

  • Removes extra tile in Pub/Sub getting started landing page for Flutter. This was previously removed but seems to have been re-added.
  • Removes both Pub/Sub and Chat SDK set up.
  • Creates a Chat getting started landing page.
  • Redirects the relevant SDK set up page to the getting started landing page.
  • Updates SDKs page by removing the GitHub button, renames the Setup page to 'Get started' and links to the relevant getting started guide for that language.

@GregHolmes GregHolmes self-assigned this Sep 15, 2025
@GregHolmes GregHolmes added the review-app Create a Heroku review app label Sep 15, 2025
Copy link

coderabbitai bot commented Sep 15, 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 (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started

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.

@ably-ci ably-ci temporarily deployed to ably-docs-edu-2044-revi-eau3qd September 15, 2025 12:43 Inactive
@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from 59c448e to 7733a01 Compare September 17, 2025 08:40
@GregHolmes GregHolmes temporarily deployed to ably-docs-edu-2044-revi-eau3qd September 17, 2025 08:40 Inactive
@GregHolmes GregHolmes had a problem deploying to ably-docs-edu-2044-revi-eau3qd September 17, 2025 08:41 Failure
@GregHolmes GregHolmes had a problem deploying to ably-docs-edu-2044-revi-eau3qd September 17, 2025 08:55 Failure
@GregHolmes GregHolmes temporarily deployed to ably-docs-edu-2044-revi-eau3qd September 17, 2025 09:06 Inactive
@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch 3 times, most recently from 8ed90ba to 2ccdebb Compare September 25, 2025 14:31
@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from 20c9a96 to f7c5286 Compare September 30, 2025 13:07
Copy link
Contributor

@franrob-projects franrob-projects left a comment

Choose a reason for hiding this comment

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

Some general points (or thoughts).

  • IS the redirect to the landing page is sufficient?
  • should there be "middle ground" redirects to language-specific pages for the same links?

and

  • I think the general structure could be more similar between pub/sub and chat "getting started" landing pages.
  • and consistent tile ordering

And agree with waht @m-hulbert commented also :)

@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch 2 times, most recently from 63aae82 to 3a2658b Compare October 3, 2025 10:35
@GregHolmes
Copy link
Contributor Author

Thanks @m-hulbert I've made the changes recommended.

@franrob-projects If I understand correctly on your first point, you're recommending that we implement some sort of functionality that checks whether the lang param the user has when accessing sdk set up page should determine at the point of redirect which getting started page they go to? It's possible, but I'm not sure it's worth the effort right now. Redirects are a temperamental setup. Redirecting the user just to the getting started landing page only exposes them to the tiles of all the getting started guides available.

On your section comment:

I think the general structure could be more similar between pub/sub and chat "getting started" landing pages.
and consistent tile ordering

I'm not sure I understand. They are very simple pages. I had to add sub headers in the Chat one as we broke the React UI component guide away from the standard getting started guides. Other than that there's no difference.

The tile ordering is consistent too.

If you compare the two, Pub/Sub has (in exact order):

  • JavaScript
  • Node.js
  • React
  • React Native
  • Kotlin
  • Swift
  • ... And the others.

Chat has (in order):

  • JavaScript
  • React
  • React Native
  • Kotlin
  • Swift

I apologise if I misunderstood but was this the part you referring to in inconsistent tile ordering?

@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from d26eee6 to f467473 Compare October 3, 2025 10:52
@franrob-projects
Copy link
Contributor

franrob-projects commented Oct 3, 2025

@franrob-projects If I understand correctly on your first point, you're recommending that we implement some sort of functionality that checks whether the lang param the user has when accessing sdk set up page should determine at the point of redirect which getting started page they go to?

Yes that I was I was refering to.

If you compare the two, Pub/Sub has (in exact order):

  • JavaScript
  • Node.js
  • React
  • React Native
  • Kotlin
  • Swift
  • ... And the others.

Chat has (in order):

  • JavaScript
  • React
  • React Native
  • Kotlin
  • Swift

I apologise if I misunderstood but was this the part you referring to in inconsistent tile ordering?

There is [Getting started: Chat in Android] in between React native and Kotlin on the live site and in your PR.

@GregHolmes
Copy link
Contributor Author

There is [Getting started: Chat in Android] in between React native and Kotlin on the live site and in your PR.

Yep, I noticed that while responding to you and added it as a new commit. But I'm not sure what you meant by I think the general structure could be more similar between pub/sub and chat "getting started" landing pages.,

The tile ordering is consistent too, it's just that one was missing at the time you made the comment.

@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from f467473 to 20f3216 Compare October 3, 2025 11:53
@franrob-projects
Copy link
Contributor

franrob-projects commented Oct 3, 2025

But I'm not sure what you meant by I think the general structure could be more similar between pub/sub and chat "getting started" landing pages.,

The point I'm making is:

  • The landing page (for your redirects) is the Getting started with Pub/Sub guides -> overview page.

  • There is no overview page for Getting started with Chat; instead, the "overview page" for the Chat getting started guides is a list under About Chat.

So, I have my comment.

Also, for a bit of extra consistency:

  • On the Pub/sub get started overview page, we have the title "get started", then on all these guides, we have "getting started".

  • This would be a nice style fix.

@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from da76750 to 88803b0 Compare October 3, 2025 13:39
@GregHolmes GregHolmes force-pushed the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch from 0e5f8fd to cbe0398 Compare October 3, 2025 13:44
@GregHolmes
Copy link
Contributor Author

GregHolmes commented Oct 3, 2025

We've decided not to remove the sdk setup page for Chat at this moment as there's key authentication points in it that'll need to be brought into the ongoing authentication rewrite. So for the time being it's staying where it is, this is why there's not a redirect for Chat in this PR.

Ok, that's the status, cool!!

@GregHolmes GregHolmes merged commit 0eeba65 into main Oct 6, 2025
6 checks passed
@GregHolmes GregHolmes deleted the EDU-2044-Review-whether-we-can-should-consolidate-SDK-setup-pages-into-getting-started branch October 6, 2025 09:36
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