docs icon indicating copy to clipboard operation
docs copied to clipboard

Where is the canonical place for documentation on how you publish a message to a channel?

Open SimonWoolf opened this issue 4 years ago • 0 comments

Where is the canonical place for documentation on how you publish a message to a channel?

  • There's a "publishing messages" section on https://www.ably.io/documentation/rest/messages#message-publish

  • There's a "publishing to a channel" section on https://www.ably.io/documentation/rest/channels#publishing

What's the difference?

Both have example publish code snippets, in slightly different styles. Both have paragraphs on batch publishing, with slightly different wording. The messages page also has a paragraph on idempotent publishing, which the channels page doesn't. The channels page has a paragraph on encryption which the messages page doesn't. The channels page has the actual api docs. The messages page doesn't, though it still thinks it does (they still appear in the jump-to dropdown).


Everything you do on a channel is something to do with messages. Everything you do with messages happens on a channel. These used to be a single page, there was one place for this information. Now it's stretched over two pages, with some things duplicated, and others appearing only on one page or another, making them less discoverable depending on which the user happened to land on first. What is the point of this split?

@kavalerov @tbedford @mattheworiordan @tomczoink

┆Issue is synchronized with this Jira Task by Unito

SimonWoolf avatar Jan 19 '21 10:01 SimonWoolf