chore: move AppKit and WalletKit one level higher, out of TON Connect#1867
chore: move AppKit and WalletKit one level higher, out of TON Connect#1867
Conversation
This comment has been minimized.
This comment has been minimized.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| import { Aside } from '/snippets/aside.jsx'; | ||
|
|
||
| This guide helps you integrate your custodial or non-custodial wallet with TON or partially build a basic, fresh one from scratch with the help of [TON Connect](/ecosystem/ton-connect/overview) and [WalletKit](/ecosystem/ton-connect/walletkit/overview). | ||
| This guide helps you integrate your custodial or non-custodial wallet with TON or partially build a basic, fresh one from scratch with the help of [TON Connect](/ecosystem/ton-connect/overview) and [WalletKit](/ecosystem/walletkit/overview). |
There was a problem hiding this comment.
[HIGH] Reader-facing pronouns in wallet integration overview
Line 8 uses second-person phrasing (“This guide helps you integrate your custodial or non-custodial wallet…”) that directly addresses the reader with “you/your.” The documentation style guide prohibits using “you/your” to refer to the reader in narrative prose, classifying this as a high-severity language issue. This line is part of the modified diff hunk (the WalletKit link target changed), so the pronoun usage must be corrected as part of this update.
| This guide helps you integrate your custodial or non-custodial wallet with TON or partially build a basic, fresh one from scratch with the help of [TON Connect](/ecosystem/ton-connect/overview) and [WalletKit](/ecosystem/walletkit/overview). | |
| This guide describes how to integrate a custodial or non-custodial wallet with TON or partially build a basic wallet from scratch using [TON Connect](/ecosystem/ton-connect/overview) and [WalletKit](/ecosystem/walletkit/overview). |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| Initialize the WalletKit before managing wallets. See the [initialization guide](/ecosystem/walletkit/android/init) for details. | ||
| </Aside> | ||
|
|
||
| The SDK provides a comprehensive API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. |
There was a problem hiding this comment.
[HIGH] Prohibited marketing adjective “comprehensive” in WalletKit Android wallets guide
The introductory line in the Android wallets guide (line 12) describes the SDK as providing “a comprehensive API for creating, retrieving, and managing wallets.” The style guide’s marketing‑language rule bans vague, promotional adjectives like “comprehensive” when they are not backed by concrete, measurable criteria, and classifies them as HIGH‑severity violations. This wording introduces non‑actionable hype in a section that should neutrally describe capabilities. The rest of the page already focuses on specific features and patterns, so keeping this adjective undermines the desired neutral, technical tone.
| The SDK provides a comprehensive API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. | |
| The SDK provides an API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| Initialize the WalletKit before managing wallets. See the [initialization guide](/ecosystem/walletkit/ios/init) for details. | ||
| </Aside> | ||
|
|
||
| The SDK provides a comprehensive API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. |
There was a problem hiding this comment.
[HIGH] Prohibited marketing adjective “comprehensive” in WalletKit iOS wallets guide
The parallel iOS wallets guide repeats the phrase “a comprehensive API for creating, retrieving, and managing wallets” in line 12. As in the Android version, “comprehensive” is a vague positive adjective that the style guide’s marketing‑language rule explicitly prohibits at HIGH severity when not tied to objective criteria. This phrasing adds unjustified promotion instead of factual description and makes the iOS and Android guides jointly deviate from the neutral house style. Aligning both pages to a straightforward description of what the API does resolves the issue and keeps the platform‑specific docs consistent.
| The SDK provides a comprehensive API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. | |
| The SDK provides an API for creating, retrieving, and managing wallets. All wallet operations follow a three-step pattern. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
There was a problem hiding this comment.
[HIGH] Prohibited second‑person pronoun in native‑web guide
The on‑premise bridge setup section uses second‑person phrasing (“you can deploy”, “You will need to”) in lines 82–84 to address the reader directly. The extended style guide explicitly forbids using “you”/“your” to refer to the reader and classifies this as a HIGH‑severity “don’t get personal” violation. Keeping this wording would introduce inconsistent, conversational tone relative to the rest of the documentation. The rest of the guide already uses neutral, instructional language, so these lines stand out as non‑compliant.
| For this option, deploy the [official TON Connect Bridge implementation][bridge-repo]. | |
| To complete this setup: |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
There was a problem hiding this comment.
[HIGH] Prohibited first‑person plural in WalletKit QA guide (demo dApps description)
The demo dApps subsection in lines 75–77 uses first‑person plural language (“We have a dApp…”, “In our testing platform, it is called GENERAL/ CUSTOM”) to refer to the authors and their platform. The style guide explicitly disallows “we”/“our” for authors and requires neutral nouns (“TON Foundation”, “the testing platform”) instead, treating this as a HIGH‑severity “don’t get personal” violation. These sentences shift the perspective from objective documentation to author‑centric narration and create inconsistency with surrounding sections that describe the system in neutral terms. The rest of the section can remain unchanged once these references are made impersonal.
| The [dApp for TON Connect testing](https://tonconnect-sdk-demo-dapp.vercel.app/) is used in most test cases; in the testing platform, it is called **GENERAL**. | |
| Additionally, several demo dApps are used for testing specific scenarios; in the testing platform, this group is called **CUSTOM**. Each test case includes a Description field indicating which dApp to use: **GENERAL** or **CUSTOM**. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
There was a problem hiding this comment.
[HIGH] Prohibited second‑person pronoun in WalletKit QA guide (basic connection test)
The basic connection test outcome sentence in line 123 addresses the reader and their integration directly (“If this works, your basic integration is successful, and you can start using our testing platform suites. If your wallet doesn't appear…”). The style guide’s “Don’t get personal” rule bans using “you”/“your” to refer to the reader anywhere in the docs and marks these as HIGH‑severity violations. This line breaks the otherwise impersonal tone of the QA guide and introduces author‑to‑reader narration that the style guide is designed to avoid. The issue is confined to this specific sentence within the newly added testing section.
| If the basic connection test succeeds, the integration is considered successful, and testing platform suites become applicable. If the wallet does not appear in the list or the connection fails, revisit the technical implementation guides. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| </Aside> | ||
|
|
||
| The [basic configuration earlier](/ecosystem/ton-connect/walletkit/web/init#initialization) is enough to outline necessary wallet information and initialize the WalletKit, but it isn't enough for deeper interactions with the blockchain. For that, you need to set up at least one TON wallet contract. | ||
| The [basic configuration earlier](/ecosystem/walletkit/web/init#initialization) is enough to outline necessary wallet information and initialize the WalletKit, but it isn't enough for deeper interactions with the blockchain. For that, you need to set up at least one TON wallet contract. |
There was a problem hiding this comment.
[HIGH] Reader-facing pronoun in WalletKit web wallets introduction
Line 12 contains the phrase “For that, you need to set up at least one TON wallet contract,” which explicitly addresses the reader with “you.” This violates the style guide rule against using “you/your” for the reader and appears in a newly added file in this PR, so the issue is introduced (or reintroduced) by the current diff. The requirement can be expressed in neutral, impersonal language without changing the technical meaning.
| The [basic configuration earlier](/ecosystem/walletkit/web/init#initialization) is enough to outline necessary wallet information and initialize the WalletKit, but it isn't enough for deeper interactions with the blockchain. For that, you need to set up at least one TON wallet contract. | |
| The [basic configuration earlier](/ecosystem/walletkit/web/init#initialization) is enough to outline necessary wallet information and initialize the WalletKit, but it is not sufficient for deeper interactions with the blockchain. For deeper interactions, configure at least one TON wallet contract. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| If you do not yet have a mnemonic for an existing TON wallet or you want to create a new one, you can generate a TON-specific mnemonic with the `CreateTonMnemonic()` function. However, it is crucial to use that function only **once per wallet** and then save it securely. | ||
|
|
||
| You **must NOT** invoke this function amidst the rest of your project code. |
There was a problem hiding this comment.
[HIGH] Reader-facing pronouns in WalletKit mnemonic safety guidance
The caution block at lines 144–146 uses multiple second-person constructions (“If you do not yet have a mnemonic… or you want to create a new one, you can generate…”, “You must NOT invoke this function…”). These sentences address the reader directly and therefore conflict with the documentation rule prohibiting “you/your.” This block is part of the newly added wallets.mdx file in this PR, so the reader-facing language should be rewritten in a neutral form while preserving the safety guidance.
| If no mnemonic is available for an existing TON wallet or a new wallet must be created, generate a TON-specific mnemonic with the `CreateTonMnemonic()` function. Use this function only **once per wallet** and then store the resulting mnemonic securely. | |
| Invoking this function must be limited to one-off scripts, not integrated into the rest of the project code. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
2 participants
Closes #1866
This would hurt #1861 and #1783 a little, but it's manageable.