feat(ton-pay): add structure #1762
Conversation
|
To fix the formatting issues:
npm run fmt:some -- ecosystem/ton-pay/api-reference.mdx ecosystem/ton-pay/overview.mdx ecosystem/ton-pay/payment-integration/payments-react.mdx ecosystem/ton-pay/payment-integration/payments-tonconnect.mdx ecosystem/ton-pay/payment-integration/status-info.mdx ecosystem/ton-pay/payment-integration/transfer.mdx ecosystem/ton-pay/quick-start.mdx ecosystem/ton-pay/ui-integration/button-js.mdx ecosystem/ton-pay/ui-integration/button-react.mdx ecosystem/ton-pay/webhooks.mdx |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| --- | ||
| title: "TonPay button using JS" | ||
| sidebarTitle: "Button JS" | ||
| --- |
There was a problem hiding this comment.
[HIGH] Incorrect TON casing in JS button title
The JS button documentation frontmatter title uses TonPay instead of the canonical TON casing, conflicting with the TON-specific casing rules in contribute/style-guide-extended.mdx:1111-1114. This inconsistency can confuse readers and breaks searchability and brand consistency across the TON Pay SDK docs. The React button page shows the same issue, so fixing this title helps keep the entire UI integration group aligned with the TON Pay SDK naming. The primary location here points to the newly added frontmatter lines that introduce the incorrect casing.
| --- | |
| title: "TonPay button using JS" | |
| sidebarTitle: "Button JS" | |
| --- | |
| --- | |
| title: "TON Pay button using JS" | |
| sidebarTitle: "Button JS" | |
| --- |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| --- | ||
| title: "TonPay button using JS" | ||
| sidebarTitle: "Button JS" | ||
| --- |
There was a problem hiding this comment.
[HIGH] TonPay JS button How-to frontmatter not set
The new TonPay JS button UI integration page uses a generic title ("TonPay button using JS") and sidebarTitle ("Button JS") instead of following the required How to X frontmatter pattern for How‑to pages. According to the style guide’s How‑to frontmatter rule (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L956-L976), How‑to pages must use title: "How to X" and set sidebarTitle to X or a shorter alias of X. This inconsistency harms searchability for “how to …” queries and makes navigation labels less predictable. Aligning the frontmatter with the pattern keeps the How‑to docs coherent and easier to scan in the sidebar.
| --- | |
| title: "TonPay button using JS" | |
| sidebarTitle: "Button JS" | |
| --- | |
| --- | |
| title: "How to add TonPay button using JS" | |
| sidebarTitle: "Add TON Pay button using JS" | |
| --- |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| --- | ||
| title: "TonPay button using React" | ||
| sidebarTitle: "Button React" | ||
| --- |
There was a problem hiding this comment.
[HIGH] Incorrect TON casing in React button title
The React button documentation frontmatter title also uses TonPay instead of the prescribed TON casing, again violating the TON-specific casing rule in contribute/style-guide-extended.mdx:1111-1114. This leads to inconsistent branding within the TON Pay SDK docs and can reduce clarity when users navigate or search for TON-related content. The JS button page exhibits the same pattern, so harmonizing both titles with TON Pay SDK ensures consistent terminology across the UI integration group. The location above targets the new frontmatter block that introduces the incorrect casing in this file.
| --- | |
| title: "TonPay button using React" | |
| sidebarTitle: "Button React" | |
| --- | |
| --- | |
| title: "TON Pay button using React" | |
| sidebarTitle: "Button React" | |
| --- |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| --- | ||
| title: "TonPay button using React" | ||
| sidebarTitle: "Button React" | ||
| --- |
There was a problem hiding this comment.
[HIGH] TonPay React button How-to frontmatter not set
The new TonPay React button UI integration page also uses a non‑conforming title ("TonPay button using React") and sidebarTitle ("Button React"), instead of the mandated How to X pattern for How‑to content. Per the How‑to frontmatter rule in the extended style guide (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L956-L976), How‑to pages must have title: "How to X" and a sidebarTitle equal to X or a concise alias. This misalignment reduces consistency with other How‑to docs and weakens “how to …” search behavior and sidebar clarity. Updating the frontmatter to match the pattern restores consistency and improves discoverability.
| --- | |
| title: "TonPay button using React" | |
| sidebarTitle: "Button React" | |
| --- | |
| --- | |
| title: "How to add TonPay button using React" | |
| sidebarTitle: "Add TonPay button using React" | |
| --- |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
closes #1738