-
Notifications
You must be signed in to change notification settings - Fork 14
feat: add toncenter overview and rate limit pages #1054
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?
Conversation
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/rpc/toncenter/rate-limit.mdx ecosystem/rpc/toncenter/overview.mdx |
|
/review |
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.
No documentation issues detected.
|
@laviniat1996 Since this is not only about versions, but also about different architectures API v2 and API v3, we expect differences that will be better specified independently. |
|
@reveloper Thank you for reviewing. I sent this PR to Ruslan yesterday, he asked me to wait a bit till he reviews the unified page before splitting it in two. |
|
I want to also mention: I know we should have one page per PR, but in this case the overview contains a link to the rate limit page, and I made an exception. |
|
Waiting for Ruslan's review. Please ping when it's ready to be merged. |
|
Conflicts, moving to Draft. |
kdimentionaltree
left a 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.
Here are several things I'd request to improve:
- Transpose table with APIs so mainnet and testnet becomes columns. There are several more APIs, TON Center provides. It would be easier to add them into transposed table.
- Hosted Access -> Managed Service, Self-Hosting -> Self-Hosted Service. These names better fit in my opinion.
- All appearance of v3 and v2 would better to replace with "API v3" and "API v2".
- Rate limiting -> Managed plans and rate limiting.
- Common mistakes: describe a case when user bought subscription, but he faces ratelimit of 1RPS.
- Check that API key is specified properly. RPS with API key should be 10RPS insdead of 1RPS. Facing 1RPS means API key isn't properly specified.
- Subscription plans and API key changes are applies within 10 minutes to TON Center rate limiting.
…ystem/rpc -> ecosystem/api (#1064) - other minor structure improvements # Conflicts: # docs.json # ecosystem/api/toncenter/rate-limit.mdx
* feat: allow <kbd> * feat: clarify aside usage * feat: clarify pronouns * feat: format internal references as links
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kdimentionaltree
left a 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.
Updated rateliming rules.
#1327
Closes #1044
Closes #1041
Added new overview.mdx page for TON Center, covering hosted access and API environments
Added new rate-limit.mdx page explaining plan tiers, default limits, and rate-limit behavior.