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

Duplication / group issues of channel options and other concepts in the channels docs #1495

Open
mattheworiordan opened this issue Jul 17, 2022 · 0 comments
Labels
bug A broken link, image etc

Comments

@mattheworiordan
Copy link
Member

mattheworiordan commented Jul 17, 2022

We introduce the concept of channel params quite early in the channel docs, see https://ably.com/docs/realtime/channels#setting-channel-options. I would say this is too early given we want to help people understand the core concepts like publishing & subscribing first, but nonetheless we do that. That is covered in section 2.1 i.e. the very first thing a person learns about once they have seen the basic example. Then we talk about setting channel options in 2.9 (after we've covered 8 sections) see https://ably.com/docs/realtime/channels#modifying-options, yet we make no reference to what those options are in 2.1. This doesn't make sense IMHO.

We see a similar lack of continuity with channel lifecycle in 2.4 https://ably.com/docs/realtime/channels#channel-lifecycle, which doesn't actually cover the states of a channel or mention it. We then move onto 2.5 which is metadata, and then come back to attach related topics in 2.6 https://ably.com/docs/realtime/channels#implicit-attach with implicit attach. Then later we talk about channel states in 2.11 https://ably.com/docs/realtime/channels#channel-states, which is not linked up with the two prior topics that are related. In addition, none of the channel state stuff is grouped into say 2.X.Y where Y is everything to do with channel states.

┆Issue is synchronized with this Jira Task by Unito

@mattheworiordan mattheworiordan added bug A broken link, image etc api-reference Anything that appears below the API reference blue fold labels Jul 17, 2022
@leggetter leggetter removed the api-reference Anything that appears below the API reference blue fold label Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A broken link, image etc
Development

No branches or pull requests

2 participants