-
Notifications
You must be signed in to change notification settings - Fork 4
add ecosystem -> rpc -> ton center overview + 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. |
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
* upd(jettons/tokens): add decimals Insert it into jeeton metadata subsection on the metadata page. Also added link to this on Jetton how to transfer page. --------- Co-authored-by: skywardboundd <[email protected]>
Complete transfer from LaTeX to webview of the TON Blockchain whitepaper.
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/api/toncenter/rate-limit.mdx ecosystem/api/toncenter/overview.mdx |
|
@kdimentionaltree Thank you for the feedback! I've addressed all your comments, if you want to take a look. |
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.
Thanks for the update—across ecosystem/api/toncenter I left several suggestions to fix tone and internal link format; please apply the inline suggestions.
| Hosted access means using TON Center’s managed infrastructure instead of running your own node. This lets you | ||
| connect to the network immediately, without setup or maintenance. | ||
|
|
||
| You can start making requests without an API key at a default rate of 1 request per second. |
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.
[HIGH] Second-person pronouns in technical docs
Lines 123–126 address the reader directly (“This lets you…”, “You can start…”) which violates the “don’t get personal” style rule. This tone reduces neutrality and can hinder translation quality and consistency. Keep phrasing neutral and impersonal (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L172).
| Hosted access means using TON Center’s managed infrastructure instead of running your own node. This lets you | |
| connect to the network immediately, without setup or maintenance. | |
| You can start making requests without an API key at a default rate of 1 request per second. | |
| Hosted access uses TON Center’s managed infrastructure instead of running a personal node. This approach enables | |
| immediate network access without setup or maintenance. | |
| Requests without an API key are limited to a default rate of 1 request per second. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
|
|
||
| You can start making requests without an API key at a default rate of 1 request per second. | ||
|
|
||
| To increase this limit or access private liteservers, generate an [API key](./get-api-key) and [choose a plan](./rate-limit) that suits your needs. |
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.
[HIGH] Internal links use relative paths
Line 128 links to internal pages using relative URLs ./get-api-key and ./rate-limit. The style guide requires all internal links to be root-absolute to remain stable across file moves. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629.
| To increase this limit or access private liteservers, generate an [API key](./get-api-key) and [choose a plan](./rate-limit) that suits your needs. | |
| To increase this limit or access private liteservers, generate an [API key](/ecosystem/api/toncenter/get-api-key) and [choose a plan](/ecosystem/api/toncenter/rate-limit) that suits your needs. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| To ensure stability and fair access, TON Center applies rate limits to all API requests.\ | ||
| If your application exceeds these limits, the API returns a **429** response. | ||
|
|
||
| You can increase your limits by [requesting an API key](./get-api-key) and selecting a higher subscription plan. |
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.
[HIGH] Internal link uses a relative path
Line 11 links to an internal page using ./get-api-key. Internal links must be root-absolute to avoid breakage when files move or paths are refactored. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L625-L629.
| You can increase your limits by [requesting an API key](./get-api-key) and selecting a higher subscription plan. | |
| You can increase your limits by [requesting an API key](/ecosystem/api/toncenter/get-api-key) and selecting a higher subscription plan. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## Rate limit exceeded | ||
|
|
||
| When requests are sent faster than the allowed rate limit, the TON Center API temporarily blocks new ones.\ | ||
| You’ll receive a JSON response that tells you the rate limit was exceeded: |
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.
[HIGH] Reader-directed pronouns (“you”, “your”)
Line 34 uses “You’ll receive…,” addressing the reader directly. Rephrase to neutral language per the style guide. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L172.
| You’ll receive a JSON response that tells you the rate limit was exceeded: | |
| A JSON response indicates the rate limit was exceeded: |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
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.