Skip to content

Commit

Permalink
content-standardization_proofread
Browse files Browse the repository at this point in the history
  • Loading branch information
reveloper authored Feb 7, 2025
1 parent fdb9773 commit 36a00d1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/v3/contribute/content-standardization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import ThemedImage from '@theme/ThemedImage';

# Content standardization

This guideline aims to maintain a consistent documentation style and help contributors standardize their content to integrate into the documentation seamlessly.
This guideline aims to maintain a consistent documentation style and help contributors standardize their content so that it seamlessly integrates into the documentation.

## Content preferences

Expand Down Expand Up @@ -83,7 +83,7 @@ Read more about [smart contracts](/v3/documentation/smart-contracts/overview)
Read more about [smart contracts](/mandarin/v3/documentation/smart-contracts/overview)
```

Set a trailing slash to all links. This keeps links consistent and avoids redirects, which hurts site performance.
Set a trailing slash to all links. This approach keeps links consistent and avoids redirects, which hurts site performance.

#### Correct link:
```md
Expand Down Expand Up @@ -161,7 +161,7 @@ import ThemedImage from '@theme/ThemedImage';

To depict message processing, use a graphical representation that resembles a smart contract graph, including labels for transactions and messages.

If the transaction order isn't essential, omit their labels. This simplifies the diagram, making it easier to read and understand the message and contract details.
If the transaction order isn't essential, omit their labels. This approach simplifies the diagram, making it easier to read and understand the message and contract details.

### Annotation primitives

Expand All @@ -181,9 +181,9 @@ If the transaction order isn't essential, omit their labels. This simplifies the

### Message processing schemes

On the TON blockchain, it is essential to provide clear explanations of actor behavior and message processing for various smart contracts and fundamental scenarios.
On the TON blockchain, providing clear explanations of actor behavior and message processing for various smart contracts and fundamental scenarios is essential.

The message processing schemes offer additional context for readers seeking a clear understanding of actor behavior. To ensure maximum clarity, these schemes should be unified throughout the TON documentation.
The message processing schemes offer additional context for readers seeking a clear understanding of actor behavior. These schemes should be unified throughout the TON documentation to ensure maximum clarity.

#### Example

Expand All @@ -201,7 +201,7 @@ The message processing schemes offer additional context for readers seeking a cl

### Sequence diagram

It is advisable to use a sequence diagram for complex and repetitive communication schemes between 2-3 actors. For messages, use the notation of a common synchronous message arrow.
Use a sequence diagram for complex and repetitive communication schemes between 2-3 actors. For messages, use the notation of a typical synchronous message arrow.

#### Example

Expand Down

0 comments on commit 36a00d1

Please sign in to comment.