Skip to content

Commit cbe081a

Browse files
authored
1187-documentation-fixes-pt-ii (#1188)
* check * folders * tenses * emojis-icons * BoC * headers formatting * my_code * comparing connection keys * sent case * ui elements * ui elements guidelines sections * concepts * check * check1 * guidelines * imgs * documentation
1 parent 17768f7 commit cbe081a

File tree

119 files changed

+1193
-2737
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+1193
-2737
lines changed

docs/v3/concepts/dive-into-ton/go-from-ethereum/solidity-vs-func.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ In the case of FunC, the main data types are:
4343
- **Tuples** — is an ordered collection of up to 255 components, having arbitrary value types, possibly distinct.
4444
- **Tensors** — is an ordered collection ready for mass assigning like: `(int, int) a = (2, 4)`. A special case of tensor type is the unit type `()`. It represents that a function doesn’t return any value or has no arguments.
4545

46-
Currently, FunC does not support defining custom types. Read more about types in [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
46+
Currently, FunC does not support defining custom types. Read more about types in the [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
4747

4848
### Declaring and using variables
4949

@@ -64,7 +64,7 @@ FunC is a more abstract and function-oriented language. It supports dynamic typi
6464
var z = x + y; // Dynamic variable declaration
6565
```
6666

67-
Read more in [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
67+
Read more on the [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
6868

6969
### Loops
7070

@@ -93,7 +93,7 @@ repeat(10) {
9393
}
9494
;; x = 1024
9595
```
96-
Read more on [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
96+
Read more on the [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
9797

9898
### Functions
9999

@@ -133,7 +133,7 @@ Most of the control structures known from curly-braces languages are available i
133133
#### FunC
134134
FunC supports classic `if-else` statements, `ifnot`, `repeat`, `while`, and `do/until` loops. Also, since v0.4.0, `try-catch` statements are supported.
135135

136-
Read more in [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
136+
Read more on the [Statements](/v3/documentation/smart-contracts/func/docs/statements/) page.
137137

138138
### Dictionaries
139139

@@ -233,7 +233,7 @@ send_raw_message(msg, mode);
233233
234234
This example presented how smart contracts can communicate with each other.
235235
236-
Read more in [Internal Messages](/v3/documentation/smart-contracts/overview/) page.
236+
Read more on the [Internal messages](/v3/documentation/smart-contracts/overview/) page.
237237
238238
## See also
239239

docs/v3/concepts/dive-into-ton/go-from-ethereum/tvm-vs-evm.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,25 @@ import Feedback from '@site/src/components/Feedback';
1010
### Data presentation
1111

1212
#### EVM
13-
1. Fundamental Data Units
14-
The EVM operates primarily on 256-bit integers, reflecting its design around Ethereum's cryptographic functions, such as Keccak-256 hashing and elliptic curve operations.
13+
1. Fundamental data units
14+
15+
- The EVM operates primarily on 256-bit integers, reflecting its design around Ethereum's cryptographic functions, such as Keccak-256 hashing and elliptic curve operations.
1516
- Data types are limited mainly to integers, bytes, and occasionally arrays of these types, but all must conform to 256-bit processing rules.
16-
2. State Storage
17+
2. State storage
1718
- The entire state of the Ethereum blockchain is a mapping of 256-bit addresses to 256-bit values. A data structure known as the **Merkle Patricia Trie (MPT)** maintains this mapping.
1819
- The MPT enables Ethereum to efficiently prove the consistency and integrity of the blockchain state through cryptographic verification, which is vital for a decentralized system like Ethereum.
19-
3. Data Structure Limitations
20+
3. Data structure limitations
2021
- The simplification to 256-bit word constraints means that the EVM is not inherently designed to handle complex or custom data structures directly.
2122
Developers often need to implement additional logic within smart contracts to simulate more complex data structures, which can increase gas costs and complexity.
2223

2324
#### TVM
24-
1. Cell-Based Architecture
25+
1. Cell-based architecture
2526
- TVM uses a unique [bag of cells](/v3/documentation/data-formats/tlb/cell-boc/) model to represent data. Each cell can contain up to 128 data bytes and have up to 4 references to other cells.
2627
- This structure allows the TVM to natively support arbitrary algebraic data types and more complex constructions such as trees or directed acyclic graphs (DAGs) directly within its storage model.
27-
2. Flexibility and Efficiency
28+
2. Flexibility and efficiency
2829
- The cell model provides significant flexibility, enabling the TVM to handle various data structures more naturally and efficiently than the EVM.
2930
- For example, creating linked structures through cell references allows for dynamic and potentially infinite data structures, which is crucial for specific applications like decentralized social networks or complex decentralized finance (DeFi) protocols.
30-
3. Complex Data Handling
31+
3. Complex data handling
3132
- The ability to manage complex data types inherently within the VM architecture reduces the need for workaround implementations in smart contracts, potentially lowering the execution cost and increasing execution speed.
3233
TVM's design is particularly advantageous for applications requiring complex state management or interlinked data structures. It provides a robust foundation for developers to build sophisticated and scalable decentralized applications.
3334

docs/v3/concepts/dive-into-ton/introduction.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ To understand the true vision for the decentralized internet and how TON contrib
1717

1818
<Player url="https://www.youtube.com/watch?v=XgzHmV_nnpY" />
1919

20-
* To learn more about the technical aspects of TON Blockchain, review the [Blockchain of Blockchains](/v3/concepts/dive-into-ton/ton-blockchain/blockchain-of-blockchains/)
21-
* Learn more about the development of all things TON by reviewing this section: [Getting Started](/v3/documentation/ton-documentation/)
20+
* To learn more about the technical aspects of TON Blockchain, review the [Blockchain of blockchains](/v3/concepts/dive-into-ton/ton-blockchain/blockchain-of-blockchains/)
21+
* Learn more about the development of all things TON by reviewing this section: [Getting started](/v3/documentation/ton-documentation/)
2222

2323
## Blockchain basics with TON
2424

@@ -50,9 +50,9 @@ Russian
5050

5151
## TON Blockchain development
5252

53-
__TON Blockchain Course__ is a comprehensive TON Blockchain guide. The course is designed for developers who want to learn how to create smart contracts and decentralized applications (dApps) on the TON Blockchain.
53+
__TON Blockchain course__ is a comprehensive TON Blockchain guide. The course is designed for developers who want to learn how to create smart contracts and decentralized applications (dApps) on the TON blockchain.
5454

55-
It consists of __9 modules__ and covers the basics of the TON Blockchain, the FunC programming language, and the TON Virtual Machine (TVM).
55+
It consists of __9 modules__ and covers the basics of TON Blockchain, the FunC programming language, and the TON Virtual Machine (TVM).
5656

5757

5858
<Button href="https://stepik.org/course/176754/promo"

docs/v3/concepts/dive-into-ton/ton-blockchain/cells-as-data-storage.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,13 @@ Any object in TON, like the message, block, or whole blockchain state, serialize
5555
A TL-B scheme describes the serialization process: a formal description of how this object can be serialized into _builder_ or how to parse an object of a given type from the _Slice_.
5656
TL-B for cells is the same as TL or ProtoBuf for byte-streams.
5757

58-
If you want more details about cell serialization and deserialization, read the [Cell & Bag of Cells](/v3/documentation/data-formats/tlb/cell-boc) article.
58+
If you want more details about cell serialization and deserialization, read [Cell & bag of cells](/v3/documentation/data-formats/tlb/cell-boc) article.
59+
5960

6061
## See also
6162

6263
- [Blockchain of blockchains](docs/v3/concepts/dive-into-ton/ton-blockchain/blockchain-of-blockchains/)
63-
- [TL-B Language](/v3/documentation/data-formats/tlb/tl-b-language)
64+
- [TL-B language](/v3/documentation/data-formats/tlb/tl-b-language)
6465

6566
<Feedback />
6667

docs/v3/concepts/dive-into-ton/ton-blockchain/security-measures.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,39 @@ import Feedback from '@site/src/components/Feedback';
44

55
The security of the TON blockchain ecosystem is of utmost importance. Below is a summary of completed audits conducted by renowned auditing firms for key components of the TON blockchain.
66

7-
## TON blockchain
7+
## TON Blockchain
88

99
Various security providers audited core blockchain modules to ensure their robustness and security.
1010

11-
**Audit Firms**: Trail of Bits, SlowMist, CertiK
12-
**Audit Reports**:
11+
**Audit firms**: Trail of Bits, SlowMist, CertiK
12+
**Audit reports**:
1313
- [Trail of Bits: TON Blockchain Audit Report](https://docs.ton.org/audits/TON_Blockchain_ToB.pdf)
1414
- [SlowMist: TON Blockchain Audit Report](https://docs.ton.org/audits/TON_Blockchain_SlowMist.pdf)
1515
- [CertiK: TON Blockchain Audit Report](https://docs.ton.org/audits/TON_Blockchain_CertiK.pdf)
1616
- [CertiK: TON Masterchain Contracts Formal Verification](https://docs.ton.org/audits/TON_Blockchain_Formal_Verification_CertiK.pdf)
1717

18-
## TON blockchain library (tonlib)
18+
## TON Blockchain library (tonlib)
1919

2020
Zellic conducted a security assessment for TON from October 16th to November 17th, 2023. During this engagement, Zellic reviewed Tonlib’s code for security vulnerabilities, design issues, and general weaknesses in security posture.
2121

22-
**Audit Firm**: Zellic
23-
**Audit Report**:
22+
**Audit firm**: Zellic
23+
**Audit report**:
2424
- [Zellic: Audit Report](https://docs.ton.org/audits/TON_Blockchain_tonlib_Zellic.pdf)
2525

2626
## TVM and Fift
2727

2828
Audit for TON Virtual Machine and the Fift programming language.
2929

30-
**Audit Firm**: Trail of Bits
31-
**Audit Report**:
30+
**Audit firm**: Trail of Bits
31+
**Audit report**:
3232
- [Trail of Bits Audit Report - TVM & Fift](https://docs.ton.org/audits/TVM_and_Fift_ToB.pdf)
3333

34-
## TVM Upgrade 2023.07
34+
## TVM Upgrade Jul 2023
3535

3636
Audit for security and potential vulnerabilities in TVM Upgrade 2023.07.
3737

38-
**Audit Firm**: Trail of Bits
39-
**Audit Report**:
38+
**Audit firm**: Trail of Bits
39+
**Audit report**:
4040
- [Trail of Bits Audit Report - TVM Upgrade](https://docs.ton.org/audits/TVM_Upgrade_ToB_2023.pdf)
4141

4242
---

docs/v3/concepts/dive-into-ton/ton-blockchain/smart-contract-addresses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ However, raw addresses have two main issues:
7777

7878
Convert raw, user-friendly addresses using [ton.org/address](https://ton.org/address/).
7979

80-
For more details, refer to the refhandling guide in [Addresses Documentation](/v3/documentation/smart-contracts/addresses/).
80+
For more details, refer to the refhandling guide in the [Smart contracts addresses documentation](/v3/documentation/smart-contracts/addresses/) section.
8181

8282
## See also
8383

docs/v3/concepts/dive-into-ton/ton-blockchain/ton-networking.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@ import Feedback from '@site/src/components/Feedback';
22

33
# TON networking
44

5-
The TON Ecosystem uses its peer-to-peer network protocols.
5+
TON Ecosystem uses its peer-to-peer network protocols.
66

7-
- **TON blockchain** uses these protocols to propagate new blocks, send and collect transaction candidates, etc.
7+
- **TON Blockchain** uses these protocols to propagate new blocks, send and collect transaction candidates, etc.
88

99
While the networking demands of single-blockchain projects, such as Bitcoin or Ethereum, can be met quite easily: one essentially needs to construct a peer-to-peer overlay network and then propagate all new blocks and transaction candidates via a [gossip](https://en.wikipedia.org/wiki/Gossip_protocol) protocol.
1010

1111
Multi-blockchain projects, such as TON, are much more demanding. For example, one must be able to subscribe to updates for only some shardchains, not necessarily all of them.
1212

1313

14-
- **TON Ecosystem services** like TON Proxy, TON Sites, TON Storage, and DApps run on these protocols.
14+
- **TON Ecosystem services** like TON Proxy, TON Sites, TON Storage, and dApps run on these protocols.
1515

1616
Once the more sophisticated network protocols are in place to support the TON blockchain.
17-
They can easily be used for purposes not necessarily related to the immediate demands of the blockchain itself, thus providing more possibilities and flexibility for creating new services in the TON Ecosystem.
17+
They can easily be used for purposes not necessarily related to the immediate demands of the blockchain itself, thus providing more possibilities and flexibility for creating new services in TON Ecosystem.
1818

1919
## TON network protocols
2020

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ Here are some non-custodial wallets for TON Blockchain.
4040

4141
### Tonkeeper
4242

43-
[Tonkeeper](https://tonkeeper.com/) is a central wallet in the TON Ecosystem. The Tonkeeper team developed it and has active support from both users and developers.
43+
[Tonkeeper](https://tonkeeper.com/) is a central wallet in TON Ecosystem. The Tonkeeper team developed it and has active support from both users and developers.
4444

4545
<img src="/img/docs/wallet-apps/Tonkeeper.png?raw=true" alt="Tonkeeper" width="240" height="480" style={{ display: 'block', margin: 'auto' }}/>
4646

4747

4848
#### Highlights
49-
- This app is most popular with users.
50-
- Supports all up-to-date features, including NFT and Token transfer between user wallets.
49+
- This app is the most widely used.
50+
- Supports all up-to-date features, including NFT and token transfer between user wallets.
5151
- It supports all major platforms, such as iOS and Android, but it also works on popular browsers like Firefox or Chrome.
5252

5353
#### Tonkeeper test environment
@@ -118,10 +118,10 @@ You must download a separate Sandbox application to connect to the Testnet.
118118
TonDevWallet is a wallet designed to simplify the development process for the TON Blockchain. It provides extensive tools and features to streamline your TON development experience.
119119

120120
#### Highlights
121-
TonConnect Integration: TonDevWallet seamlessly integrates with TonConnect, allowing you to connect your wallet to TON-compatible websites easily.
121+
TON Connect integration: TonDevWallet seamlessly integrates with TON Connect, allowing you to connect your wallet to TON-compatible websites easily.
122122
- Store and manage multiple private keys within TonDevWallet, giving you the flexibility to access and control various accounts.
123123
- Create multiple wallets to organize and manage different accounts for your TON development projects.
124-
- Local transaction emulation lets you preview transaction results before executing them on the TON Blockchain. This feature helps you ensure the correctness of your transactions before submitting them to the blockchain.
124+
- Local transaction emulation lets you preview transaction results before executing them on TON Blockchain. This feature helps you ensure the correctness of your transactions before submitting them to the blockchain.
125125

126126
#### Links
127127
- [GitHub](https://github.com/TonDevWallet/TonDevWallet)
@@ -242,7 +242,7 @@ Tonkey is an advanced project that introduces multi-signature functionality to T
242242

243243
- [Explorers in TON](/v3/concepts/dive-into-ton/ton-ecosystem/explorers-in-ton/)
244244
- [What is blockchain? What is a smart contract? What is gas?](https://blog.ton.org/what-is-blockchain)
245-
- [Types of Wallet Contracts](/v3/documentation/smart-contracts/contracts-specs/wallet-contracts/)
245+
- [Wallet contracts](/v3/documentation/smart-contracts/contracts-specs/wallet-contracts/)
246246

247247
<Feedback />
248248

docs/v3/concepts/educational-resources.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Russian
3636
</Button>
3737

3838

39-
#### TON blockchain development
39+
#### TON Blockchain development
4040

4141
We're proud to present the __TON Blockchain course__, a comprehensive guide to the TON Blockchain. The course is designed for developers who want to learn how to create smart contracts and decentralized applications on the TON Blockchain in engaging and interactive ways.
4242

docs/v3/contribute/content-standardization.mdx

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,54 @@ Examples:
2222
- "color" over "colour"
2323
- "analyze" over "analyse"
2424

25+
### Use present tense
26+
27+
Use present tense to describe general behavior, current functionality, and step-by-step instructions.
28+
This makes documentation clear and easy to follow.
29+
30+
**Examples:**
31+
- This guideline provides an overview of the contribution process.
32+
- The system checks the file format and shows an error if it is invalid.
33+
34+
*Avoid future or past tense for immediate or typical actions.*
35+
36+
**Avoid:**
37+
- The system will check the file format.
38+
- The user clicked the button.
39+
40+
### When to use the future or past tenses
41+
42+
Present tense is standard, but future and past tenses are allowed in specific cases.
43+
44+
**Future tense:** for actions that happen later, after a condition or delay.
45+
46+
**Examples:**
47+
- After setup, the system will send a confirmation email.
48+
- If payment fails, the user will get a notification.
49+
50+
*Avoid the future tense for immediate behavior or unreleased features. Also, avoid *would*.*
51+
52+
**Avoid:**
53+
54+
- The system will check the file format.
55+
- The API would return an error.
56+
57+
58+
**Past tense:** for describing past events like changelogs or logs.
59+
60+
**Examples:**
61+
- Version 2.1 fixed a validation issue.
62+
- The user submitted the form at 2 pm and got a 500 error.
63+
64+
*Avoid past tense in general documentation — it can imply outdated info.*
65+
66+
**Avoid:**
67+
68+
- The system checked the user’s location.
69+
- The user clicked the button.
70+
71+
72+
2573
### Use active voice
2674

2775
Sentences using active voice are more concise and efficient, making your writing more engaging and easier to comprehend.
@@ -61,6 +109,23 @@ Use the **"Mon D, YYYY"** format. This approach is standard for American readers
61109

62110
Adhering to these guidelines creates a unified approach to presenting dates, fostering clarity and comprehension throughout the TON documentation.
63111

112+
### Use of emojis and icons
113+
114+
#### In the Documentation section:
115+
- Avoid using emojis and decorative icons.
116+
- Technical documentation should be clear, professional, and distraction-free.
117+
- Use only standard formatting elements like headings, lists, and code blocks.
118+
119+
#### In the Guidelines section:
120+
- Emojis and icons are allowed to make content more engaging and friendly.
121+
- Use them purposefully and consistently, preferring functional icons such as:
122+
123+
✅ Success, ⚠️ Warning, ❌ Error.
124+
- Always use icons with supporting text — don’t rely on icons alone to convey meaning.
125+
- Avoid overly decorative or emotional emojis that don’t add meaning.
126+
- When in doubt, skip the icon. Clarity, consistency, and neutrality come first.
127+
128+
64129
## Link preferences
65130

66131
### Linking to internal pages
@@ -556,6 +621,26 @@ When using these words, refer to them in lowercase unless they are the first wor
556621
- Node
557622
- Liteserver
558623

624+
### BoC, bag of cells
625+
626+
- Use either the abbreviation **BoC** or the full term **bag of cells**.
627+
- **Bag of cells** is capitalized only when it starts a sentence or heading. In all other cases, write **bag of cells** in lowercase.
628+
- Always abbreviate **BoC**. Do not use **BOC** or **boc**.
629+
630+
**Correct usage:**
631+
632+
- BoC
633+
- Bag of cells
634+
- bag of cells
635+
636+
637+
**Incorrect usage:**
638+
639+
- BOC
640+
- boc
641+
- Bag Of Cells
642+
- Bag of Cells
643+
559644
## See also
560645

561646
- [How to contribute](/v3/contribute/)

docs/v3/contribute/typography.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,32 @@ Despite the overall _sentence case_ rule,
6060
#### Header consistency:
6161
- Avoid repeating the exact words in consecutive headers.
6262

63+
#### Header formatting:
64+
65+
Use plain text for all headers.
66+
Avoid using any formatting styles in headings:
67+
68+
- No code formatting `backticks` (``)
69+
- No bold **text**
70+
- No italics *text*
71+
- No quotation marks (“ ” or " ")
72+
- No ALL CAPS (unless it's an acronym)
73+
74+
Keep headers clean and consistent. Use formatting only in body text.
75+
76+
**Correct:**
77+
78+
- Run the TON Center service
79+
- How the smart contract works
80+
81+
**Incorrect:**
82+
83+
- *Run the TON Center service*
84+
- How the `smart contract` works
85+
- “Run the TON Center service”
86+
- HOW THE SMART CONTRACT WORKS
87+
88+
6389
#### Capitalized terms in headers
6490

6591
Sometimes, you can face specific capitalization defined as capitalized according to American English rules.

0 commit comments

Comments
 (0)