Skip to content
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

Old Ably diagrams are confusing #1494

Open
mattheworiordan opened this issue Jul 17, 2022 · 1 comment
Open

Old Ably diagrams are confusing #1494

mattheworiordan opened this issue Jul 17, 2022 · 1 comment
Labels
article Content updates not within the API reference bug A broken link, image etc

Comments

@mattheworiordan
Copy link
Member

mattheworiordan commented Jul 17, 2022

See https://ably.com/docs/core-features/pubsub and https://ably.com/docs/core-features/channels#understanding-decoupled-clients, both of them use this diagram:

MO screenshot 2022-07-17 at 20 39 01

I honestly have no idea what this diagram is trying to show users.

Given this is our Concepts documentation, so arguably the first stop for users who need to understand what a channel / pub/sub is, I believe we're setting new users up for confusion as opposed to clarity.

Looking through the docs more widely, I think a lot of the diagrams are dated and ineffective (using old styles, but more importantly, conceptually not strong). We have an opportunity to really show people quickly how Ably works in our concept docs, and arguably to some degree even in our SDK docs in the intro sections. We should strive to use richer media (GIFs, interactivity, clear diagrams etc.)

┆Issue is synchronized with this Jira Task by Unito

@mattheworiordan mattheworiordan added api-reference Anything that appears below the API reference blue fold article Content updates not within the API reference bug A broken link, image etc labels Jul 17, 2022
@leggetter leggetter removed the api-reference Anything that appears below the API reference blue fold label Jul 18, 2022
@ably-sync-bot
Copy link

➤ Tony Bedford commented:

Steven Appleby - we should come up with a better diagram, and then work with Leonie Wharton to create one that conforms to our branding and style guidelines. I would create an initial idea in Google diagrams (or whatever), and then share in topic-deved for feedback from the team. Bruce Thomas may also be able to help with this one too. Note: this ticket should focus on the diagram that was initially identified in this bug report, as we have the diagrams epic to deal with the wider work of improving diagrams generally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
article Content updates not within the API reference bug A broken link, image etc
Development

No branches or pull requests

3 participants