[EDU-2112] - Migrate REST SDK API spec Push-Admin page to MDX #2942
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
GregHolmes
force-pushed
the
EDU-2112-Convert-Pub-Sub-REST-SDK-Push-Admin-API-refs-to-MDX
branch
from
3095010 to
4ed06fc
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-2112-conv-xnmh2v
franrob-projects
left a comment
franrob-projects
left a comment
There was a problem hiding this comment.
Approved. The comments are most likely more applicable for the next pass!
Note: I know you had issues with links after merging the last batch... I have checked the links here... and they are working for me :)
|
|
||
| </If> | ||
|
|
||
| ##### `params` properties |
There was a problem hiding this comment.
Take or leave this one. This looks a little confusing. SO does the original. Poss a fix for the next phase
|
|
||
| <If lang="javascript,nodejs"> | ||
|
|
||
| ##### Returns |
There was a problem hiding this comment.
As with the original. There are lots of the same "returns" section. Even more so in this part of the page
|
|
||
| ##### Returns | ||
|
|
||
| Returns a promise. On success, the promise resolves. On failure, the promise is rejected with an [`ErrorInfo`](/docs/api/realtime-sdk/types#error-info) object that details the reason why it was rejected. |
There was a problem hiding this comment.
Another this 🐵 the link ErrorInfo is pointing to /api/realtime-sdk/types#error-info rather than /docs/api/rest-sdk/types#error-info.
There was a problem hiding this comment.
(as is the original)
GregHolmes
force-pushed
the
EDU-2112-Convert-Pub-Sub-REST-SDK-Push-Admin-API-refs-to-MDX
branch
from
4ed06fc to
3982730
Compare
GregHolmes
force-pushed
the
EDU-2112-Convert-Pub-Sub-REST-SDK-Push-Admin-API-refs-to-MDX
branch
from
3982730 to
fc1cd4b
Compare
GregHolmes
deleted the
EDU-2112-Convert-Pub-Sub-REST-SDK-Push-Admin-API-refs-to-MDX
branch
Description
This PR converts the REST SDK Push-Admin API reference page from Textile format to MDX, as part of a full textile to MDX migration.