docs
docs copied to clipboard
Push documentation API reference is not consistent
- [ ] Documentation states that is "Currently the push admin API is available in our JavaScript, Ruby, Java/Android and iOS libraries." when it is now supported additionally on PHP, Python. This statement is also misleading because all client libraries support the push admin API through the request method and accessing the underlying API directly. We need to make this clear.
- [ ] With all of our SDK documentation, we follow a format whereby users can read overview docs, read summaries of key features with some simple code examples, and then move onto the API reference. We have no API reference for push within the push docs. This is really obvious when you look at the new push PR where you can visit realtime push (
documentation/realtime/push) from the SDK nav, and there is no API reference for realtime push object, and then going to the push publish docs (/general/push/publish#direct-publishing) for example too, there is no reference to the push admin API that is used for this. We need to ensure consistency in our docs that allows a developer to both explore the IDL of the SDK using reference docs, and read the "friendlier" docs to understand the concepts and see examples. - [ ] Where we don't support a language yet for the above point, I believe we should show examples of using the
requestmethod, even if really simple with links directly to the Raw REST API, so that it's more accessible for people on these platforms and they know where to start. Currently we're not helping them discover this.
Note related old issue https://github.com/ably/docs/issues/298