-
Notifications
You must be signed in to change notification settings - Fork 45
Migrate Statistics Realtime SDK API spec to MDX #2876
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
base: main
Are you sure you want to change the base?
Migrate Statistics Realtime SDK API spec to MDX #2876
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are going to be painful to review, but thanks for getting the ball rolling!
|
||
<If lang="javascript,nodejs,java,csharp"> | ||
|
||
| Parameter | Type | Description | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these should all have the order changed to:
Paramater | Description | Type | Default |
We may even want to role the default into the description if it saves room / is simple.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the first table needs a default. But I've rearranged all of this for the second table.
|
||
<If lang="ruby"> | ||
|
||
| Parameter | Type | Description | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I meant that I think all tables should always be Param | Description | Type
- looking at this as well, I think the default (if exists) should just go at the end of the description. E.g.:
| start | Earliest time in milliseconds since the epoch for any stats retrieved. The default is the beginning of time. | `Number` |
- /docs/api/versions/v0.8/realtime-sdk/statistics | ||
--- | ||
|
||
## stats <a id="stats" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this page was missing a header for 'Methods' compared to the others. I think this will make things look less huge if we add that in and drop the level of everything else below it.
Description
This PR converts the Realtime SDK Statistics API reference page from Textile format to MDX, as part of a full textile to MDX migration.