Skip to content

Commit 137384f

Browse files
authored
1185-note-about-devwallet (#1186)
* warning * quotation marks * math equation support * midpoint * math equations * tma usdt payments demo * teps
1 parent 1d7e93f commit 137384f

File tree

7 files changed

+151
-3
lines changed

7 files changed

+151
-3
lines changed

docs/v3/concepts/dive-into-ton/ton-ecosystem/wallet-apps.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ Here are some non-custodial wallets for TON Blockchain.
3030

3131
#### For developers:
3232
* [TONDevWallet](https://github.com/TonDevWallet/TonDevWallet) - an open-source wallet for developers.
33+
34+
:::warning
35+
[TONDevWallet](https://github.com/TonDevWallet/TonDevWallet) is for development and testing only. Do **NOT** use it to store real funds — it is **insecure** and does **NOT** provide adequate protection.
36+
:::
37+
3338
* [TON Wallet](https://chrome.google.com/webstore/detail/ton-wallet/nphplpgoakhhjchkkhmiggakijnkhfnd) — Classic wallet of TON Ecosystem developed by TON Foundation. Platforms: iOS, Android, macOS, Linux, Windows.
3439
* [OpenMask](https://www.openmask.app/) — an open-source Chrome extension wallet.
3540

docs/v3/contribute/content-standardization.mdx

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import Feedback from '@site/src/components/Feedback';
2-
32
import ThemedImage from "@theme/ThemedImage";
3+
import { BlockMath, InlineMath } from 'react-katex';
4+
import 'katex/dist/katex.min.css';
5+
46

57
# Content standardization
68

@@ -272,6 +274,83 @@ Use a sequence diagram for complex and repetitive communication schemes between
272274
- Store the original files in the project's Git repository under the `/static/visio` directory to facilitate future modifications.
273275
- Learn [Visio](https://www.microsoft.com/en-us/microsoft-365/visio/flowchart-software) references directly from [Visio sources](https://github.com/ton-community/ton-docs/tree/main/static/schemes-visio/).
274276

277+
278+
## Math equations
279+
280+
To include mathematical expressions in documentation, use the [react-katex](https://katex.org/docs/supported) library. It supports both inline and block-level math using `LaTeX` syntax.
281+
282+
Import the required components at the top of your `.mdx` file:
283+
284+
```
285+
import { BlockMath, InlineMath } from 'react-katex';
286+
import 'katex/dist/katex.min.css';
287+
```
288+
These imports allow you to render `LaTeX` math expressions:
289+
- `BlockMath` is used for centered, standalone formulas.
290+
- `InlineMath` is used for short expressions inside the regular text.
291+
- The `css` import applies the necessary styling for proper rendering.
292+
293+
Contributors can use the following examples to format various types of math expressions in the documentation:
294+
295+
### Systems of equations
296+
297+
For systems of equations, use `LaTeX` formatting for clarity:
298+
299+
```
300+
<BlockMath math={`\\begin{cases}
301+
x + y = 10 \\\\
302+
2x - y = 4
303+
\\end{cases}`} />
304+
```
305+
306+
This renders the system of equations as:
307+
308+
<BlockMath math={`\\begin{cases}
309+
x + y = 10 \\\\
310+
2x - y = 4
311+
\\end{cases}`} />
312+
313+
314+
### Exponential functions
315+
316+
For exponential functions, you can use the following format:
317+
318+
```
319+
<InlineMath math="e^{x} = \lim\limits_{n\to \infty} \left( 1 + \frac{x}{n} \right)^n" />
320+
```
321+
322+
This renders the equation: <InlineMath math="e^{x} = \lim\limits_{n\to \infty} \left( 1 + \frac{x}{n} \right)^n" />
323+
324+
325+
### Fractions
326+
327+
To represent fractions, use `\frac{numerator}{denominator}:`
328+
329+
```
330+
<InlineMath math="\frac{a}{b}"/>
331+
```
332+
333+
This renders the fraction: <InlineMath math="\frac{a}{b}"/>
334+
335+
### Summation
336+
337+
For summation notation, use the following `LaTeX` formatting:
338+
```
339+
<BlockMath math="\sum_{i=1}^{n} i^2" />
340+
```
341+
This renders the summation: <BlockMath math="\sum_{i=1}^{n} i^2" />
342+
343+
### Logarithmic expressions
344+
345+
For logarithmic equations, use the following `LaTeX` syntax:
346+
347+
```
348+
<InlineMath math="\log_{b}(x)" />
349+
```
350+
351+
This renders the logarithmic expression: <InlineMath math="\log_{b}(x)" />
352+
353+
275354
## Terminology
276355

277356
### TON

docs/v3/contribute/typography.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ Sometimes, you can face specific capitalization defined as capitalized according
7070

7171
Date and Format are special terms and should be capitalized, regardless of the overall Sentence Case rule.
7272

73+
### Avoid "quotation marks"
74+
Do not use "quotation marks" to highlight terms, variables, or functions. Instead, apply **bold** for terms and `code formatting` for code references.
75+
76+
**Correct usage:**
77+
- Use **get_wallet_address** when introducing a term.
78+
- Use `get_wallet_address` when referencing a code variable or function.
79+
80+
**Incorrect usage:**
81+
- Do not use "get_wallet_address" for a term, code variable, or function.
82+
83+
7384
### Navigation menu headings
7485
The navigation menus should remain minimalistic in both the left sidebar and the top menu. For consistency and clarity, all menu headings must use Sentence case.
7586

package-lock.json

Lines changed: 38 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,13 @@
3535
"clsx": "^2.1.1",
3636
"docusaurus-plugin-sass": "^0.2.5",
3737
"dotenv": "^16.4.5",
38+
"katex": "^0.16.22",
3839
"markdown-link-extractor": "^4.0.2",
3940
"markdown-to-jsx": "^7.5.0",
4041
"prism-react-renderer": "^2.4.0",
4142
"react": "^18.3.1",
4243
"react-dom": "^18.3.1",
44+
"react-katex": "^3.1.0",
4345
"react-player": "^2.16.0",
4446
"react-tooltip": "^5.28.0",
4547
"sass": "^1.79.4",
@@ -54,7 +56,7 @@
5456
"cspell": "^8.14.2",
5557
"eslint": "^8.56.0",
5658
"husky": "^9.1.6",
57-
"typescript": "^5.6.2"
59+
"typescript": "^5.8.3"
5860
},
5961
"browserslist": {
6062
"production": [

sidebars/documentation.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ module.exports = [
3131
'v3/documentation/smart-contracts/contracts-specs/single-nominator-pool',
3232
'v3/documentation/smart-contracts/contracts-specs/precompiled-contracts',
3333
'v3/documentation/smart-contracts/contracts-specs/examples',
34+
35+
{
36+
type: 'link',
37+
label: 'TON enhancement proposals (TEPs)',
38+
href: 'https://github.com/ton-blockchain/TEPs/tree/master',
39+
},
40+
3441
],
3542
},
3643
'v3/documentation/smart-contracts/limits',

sidebars/guidelines.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,13 @@ module.exports = [
195195
'v3/guidelines/dapps/tutorials/telegram-bot-examples/accept-payments-in-a-telegram-bot',
196196
'v3/guidelines/dapps/tutorials/telegram-bot-examples/accept-payments-in-a-telegram-bot-2',
197197
'v3/guidelines/dapps/tutorials/telegram-bot-examples/accept-payments-in-a-telegram-bot-js',
198+
199+
{
200+
type: 'link',
201+
label: 'TMA USD₮ payments demo',
202+
href: 'https://github.com/ton-community/tma-usdt-payments-demo',
203+
},
204+
198205
],
199206
},
200207
],

0 commit comments

Comments
 (0)