[EDU-2046] - Migrate Realtime SDK API spec Types page to MDX #2919
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 |
franrob-projects
left a comment
franrob-projects
left a comment
There was a problem hiding this comment.
The only "must change" are the tables :)
|
|
||
| #### <If lang="javascript,nodejs,flutter,go,objc,swift,csharp">Properties</If><If lang="java">Members</If><If lang="ruby">Attributes</If> | ||
|
|
||
| | Property | Description | Type | |
There was a problem hiding this comment.
This may be an hallucination
There was a problem hiding this comment.
This isn't a hallucination, unfortunately the textile work was showing the properties header but no table. I've added the table here.
|
|
||
| | Property | Description | Type | | ||
| |----------|-------------|------| | ||
| | <If lang="javascript,nodejs,java,objc,swift,ruby,flutter">items</If><If lang="csharp,go">Items</If> | Contains a page of results; for example, an array of [`Message`](#message) or [`PresenceMessage`](#presence-message) objects for a channel history request | `Array<>` | |
There was a problem hiding this comment.
This may be an hallucination
There was a problem hiding this comment.
Same here. Not a hallucination,b ut something that was missing in the first place. However showed the header.
|
|
||
| <If lang="javascript,nodejs"> | ||
|
|
||
| | Property | Description | |
There was a problem hiding this comment.
Tyle collumn needed
|
|
||
| <If lang="javascript,nodejs"> | ||
|
|
||
| ### Message action <a id="#message-action" /> |
There was a problem hiding this comment.
May be worth noting that the original has no sample for node
There was a problem hiding this comment.
Same here. Javascript and Nodejs in this instance are the same code. But if I don't add the node one in, it'll just be empty. I'd rather show it.
|
|
||
| `StatsIntervalGranularity` is an enum specifying the granularity of a [`Stats interval`](/docs/api/rest-sdk/statistics#stats-type). | ||
|
|
||
| <If lang="javascript"> |
There was a problem hiding this comment.
The orignal shows "You're currently viewing the Node.js docs. There either isn't a Node.js code sample for this example,"
There was a problem hiding this comment.
The JS and Node are identical. There wasn't any point just keeping the JS version and not adding the nodejs. It would just not render the new way. So I added it as it isn't anything different.
GregHolmes
force-pushed
the
EDU-2046-Convert-Pub-Sub-Types-API-refs-to-MDX
branch
3 times, most recently
from
6b967b6 to
e8e712d
Compare
franrob-projects
temporarily deployed
to
ably-docs-edu-2046-conv-y3ardz
GregHolmes
force-pushed
the
EDU-2046-Convert-Pub-Sub-Types-API-refs-to-MDX
branch
from
e8e712d to
3070e1e
Compare
Description
This PR converts the Realtime SDK Types API reference page from Textile format to MDX, as part of a full textile to MDX migration.