Skip to content

Commit

Permalink
Update staging branch with the latest main state (#776)
Browse files Browse the repository at this point in the history
* Fix according requests

* Fix link

* Add aliases

* [TON-350] add(article): Highload wallet v3 transactions

* Fix image links

* sap-list-update

* asset-processing_crush_fix

* Update enable-liteserver-node.md

* Writing the draft version

* Remove subsection

* Remarks corrected

* Added/changed post-review information

* New translations readme.mdx (Korean)

* New translations guidelines.md (Korean)

* New translations schemes-guidelines.mdx (Korean)

* New translations guidelines.md (Korean)

* Fix link in red_stone.mdx for price_manager.fc

* update inline specifier explanation

* Fix mistake with shards

* Remove tonsdk from bot

* Adds functionality description for GitHub branches

* add japanese to default

* New translations guidelines.md (Japanese)

* remove engines

* chore: rollback previous example

* Update code from tonsdk to pytoniq

* New translations principles-of-a-good-tutorial.md (Korean)

* New translations sample-tutorial.md (Korean)

* New translations readme.md (Korean)

* New translations contribution-rules.md (Korean)

* New translations maintainers.md (Korean)

* New translations participate.md (Korean)

* New translations mining.md (Korean)

* fix typos

* fix typo

* fix typo

* fix typos

* fix typo

* fix typos

* fix typos

* fix typo

* fix typo

* fix typo

* fix typo

* fix typos

* fix typo

* update dropdown menu

* fix import

* add translation of sidebar

* New translations overview.md (Chinese Simplified)

* New translations how-it-works.md (Chinese Simplified)

* New translations how-to-contribute.md (Chinese Simplified)

* New translations how-it-works.md (Chinese Simplified)

* New translations how-to-contribute.md (Chinese Simplified)

* remove content

* New translations overview.md (Chinese Simplified)

* New translations translation-style-guide.md (Chinese Simplified)

* Mandarin localization (#63)

* New translations cell-boc.mdx (Chinese Simplified)

* New translations as-contributor.md (Korean)

* New translations as-maintainer.md (Korean)

* New translations readme.mdx (Korean)

* New translations guidelines.md (Korean)

* New translations schemes-guidelines.mdx (Korean)

* New translations guidelines.md (Korean)

* New translations guidelines.md (Japanese)

* New translations principles-of-a-good-tutorial.md (Korean)

* New translations sample-tutorial.md (Korean)

* New translations readme.md (Korean)

* New translations contribution-rules.md (Korean)

* New translations maintainers.md (Korean)

* New translations participate.md (Korean)

* New translations mining.md (Korean)

* remove engines

* update dropdown menu

* fix import

* add translation of sidebar

---------

Co-authored-by: TonSquare <[email protected]>

* New translations how-it-works.md (Chinese Simplified)

* New translations how-to-contribute.md (Chinese Simplified)

* format fix

* Update to mytonctrl2 links in FullNode

* Add tip on how to use testnet config in Full Node

* Add tip about status fast in testnet

* Refactor

* Add link for testnet dump for archive node

* update default lang array

* New translations pow-givers.md (Korean)

* New translations sharding-lifecycle.mdx (Korean)

* fix header (#68)

* fix translation header

* Fix number of outgoing messages

* Remove duplicated

* Add tlb-parsers.md & Add tlb-codegen & fix link

* Separate parsers and tl-b generator

* add backend example for ton proof

* New translations send-transactions-from-highload.md (Chinese Simplified)

* New translations shards.mdx (Korean)

* New translations auditors.mdx (Korean)

* New translations outsource.mdx (Korean)

* New translations adnl.md (Korean)

* New translations getblock-ton-api.md (Korean)

* New translations overview.md (Chinese Simplified)

* New translations how-to-contribute.md (Chinese Simplified)

* cut_warining

* Stepik corrections

Added RU and CHN links as well as replaced EN -> CHN in CHN pages

* Update academy-overview.md

* Add AWS instance description

* ecosystem_messages_layout_init

* ecosystem_messages_layuot_2

Correction sidebars,js

* ecosystem-messages-layout_3

Scheme files added

* ecosystem-messages-layout_4

Cookbook update

* chrore: add info about gasless transactions

* Add information about node setup timings

* Revert "ecosystem-messages-layout_4"

This reverts commit c33a788.

* ecosystem_messages_layout_4

Cookbook Update according new schemes

* cookbook_schemes_update

Added dark scheme

* Cookbook_update

Deleting old scheme

* Cookbook_update_3

Deleting old schemes

* Update jetton_transfer_dark.svg

* Fix non latin symbol

* Scheme_Visio_added

* Update archive-node.md

update archive node requirements

* Update enable-liteserver-node.md

update liteserver requirements

* sidebar_fix

* Delete public proxy and C++ compile page

- participate/web3/sites-and-proxy
- public proxy

* Delete public proxy and C++ instruction

- participate/web3/sites-and-proxy
- public proxy
amend

* Revert "Delete public proxy and C++ instruction"

This reverts commit 4adc61a.

* tons_sites_for_apps_page_added

* Updated after review

* cut_jetton_text

Cut the jetton - as Standard operation text from the Cookbook.

* Update how-to-run-ton-site.md

* Update how-to-run-ton-site.md

* Revert wallet.md typo fix

* Add error of wrong user usage for nodes

* docs(cookbook): update Go address parsing example

* feat: ton connect tg bot integration archived

* Update single-nominator.mdx (#710)

* Update single-nominator.mdx (#711)

* collectiong_minging_fix

Transfer fixes from PR, which got stuck because of merge conflicts.

https://github.com/ton-community/ton-docs/pull/664/files

* 🐛 Fix link in doc (#685)

* Add some explanation for effective stake (#687)

Co-authored-by: Full-Hat <[email protected]>

* feat: Add tonconnect vue sdk link (#688)

* add tonconnect vue sdk link

* fix typo

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: infinityspectra <[email protected]>

* feat: upd wallets switch testnet info (#694)

Co-authored-by: igor <[email protected]>

* Add Error parsing dependencies to troubleshooting (#695)

Co-authored-by: Full-Hat <[email protected]>
Co-authored-by: AlexG <[email protected]>

* Fix typo in mode 0 of send_raw_message (#699)

This is a non-trivial typo as developer most likely refer to mode 0 to understand how token transfer works

* Update how-to-run-ton-site.md (#700)

* update ton connect docs, add video (#701)

Co-authored-by: Aliaksandr Bahdanau <[email protected]>

* Update cookbook.md date->data (#703)

* Update messages.md (#706)

Fixed Send a regular message

* fix_node_troubleshooting

added lost snippet related to Version problem

* update troubleshooting (#712)

* update_ton_connect_button

* remove mytonctrl2 branch mentions (#714)

* Scheme update 2 (#707)

* Ecosystem_schemes_layout_5

Try to change font replacement

* Ecosystem_scheme_png_update

* Ecosystem_sheme_png_2

* Update nodes-troubleshooting.md

* SAP list update

SAP list updated according current status of auditors on Ecosystem.

* added contributors wall

* single-nominator-fix

* wallet-guidelines-cut-oudated-link

* Added info run docker (#611)

* add info run in docker

* change docker repository mytonctrl

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

* Update docs/participate/run-nodes/run-docker.md

Co-authored-by: Dr. Awesome Doge <[email protected]>

---------

Co-authored-by: Sergey Andreev <[email protected]>
Co-authored-by: AlexG <[email protected]>
Co-authored-by: Dr. Awesome Doge <[email protected]>

* Fixed code for selling nft on getgems (#691)

* fixed code for selling nft on getgems

* fix first mistake with nanoTon

* added suggestions that tokens come in different decimals

---------

Co-authored-by: vityooook <[email protected]>

* feat: add high-load wallet v3 to wallet tutorial (#715)

* Update difference-of-blockchains.md (#716)

The previous link is broken, fix with ton.org pdf

* Add transaction and messages hashes examples (#718)

Co-authored-by: Aliaksandr Bahdanau <[email protected]>

* Added message modes cookbook (#724)

Co-authored-by: Vladislav Kokosh <[email protected]>

* Update data about archive node sync timings (#720)

Co-authored-by: Full-Hat <[email protected]>

* add Japanese content document translation (#743)

* Transaction outcome description (#708)

* Transaction outcome

Definition of success and some TVM details.

* Upd transaction outcome

* Update message-delivery-guarantees.mdx

* Update tvm-overview.mdx

* Update auditors.mdx

* Additional changes to Msg & Tx page (#744)

* Transaction outcome

Definition of success and some TVM details.

* Upd transaction outcome

* Update message-delivery-guarantees.mdx

* Update tvm-overview.mdx

* Update message-delivery-guarantees.mdx

* Added an example of how to send a transaction with Wallet V5 (#721)

Co-authored-by: Vladislav Kokosh <[email protected]>

* Added actual link to wallet v5 (#725)

Co-authored-by: Vladislav Kokosh <[email protected]>

* feat: upd mytonwallet switch testnet info (#726)

Co-authored-by: igor <[email protected]>

* fix bridge.ton.org link (#727)

and open external links in new page

* Add status output explanation (#728)

Co-authored-by: Full-Hat <[email protected]>
Co-authored-by: Full-Hat <[email protected]>

* Add information about api keys (#730)

Co-authored-by: Full-Hat <[email protected]>

* supplement Korean translation (#731)

Co-authored-by: lotteam003 <[email protected]>

* Adding Tatum under RPC Nodes provider (#745)

Adding Tatum under RPC Nodes provider as Tatum provides TON RPC Nodes and whole infrastructure to run Web3 Apps.

* Fix for buttons at academy page (#747)

* Transaction outcome

Definition of success and some TVM details.

* Upd transaction outcome

* Update message-delivery-guarantees.mdx

* Update tvm-overview.mdx

* Update message-delivery-guarantees.mdx

* Update academy-overview.md

Button

* add i18n ja translation (#732)

Co-authored-by: lotteam003 <[email protected]>

* Mytonctrl installer (#733)

* Add information about disabling storing archive blocks

* Add explanation to mytonctrl installer section

---------

Co-authored-by: Full-Hat <[email protected]>

* Add information about configs (#734)

Co-authored-by: Full-Hat <[email protected]>

* change link to tonapi rates documentarion (#735)

* Examples (#736)

* Update examples & add -t flag explanation

* Complete examples

---------

Co-authored-by: Full-Hat <[email protected]>

* Fix footer & add guideline (#739)

* fix & udpate footer

* update guides

* complete add footer guide

* update branch doc

* specify function

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* improve transaction processing (#741)

Co-authored-by: Aliaksandr Bahdanau <[email protected]>

* Add vue section (#738)

* add vue section

* cut numbers from header

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Add testnet.dton.io (#750)

* Add tonpy to TLB parsers and codegen (#749)

* fix jetton sample (#742)

#637

Co-authored-by: Aliaksandr Bahdanau <[email protected]>

* remove numbers (#751)

* Update node-types.md (#748)

* Added tonutils SDK to the Python SDKs section (#740)

* update_bridge_example_link

* Add -c flag explanation in liteserver test node (#670)

* Add -c flag explanation in liteserver test node

* Update links to mytonctrl master

* Update examples & add -t flag explanation

* Add -c flag explanation in liteserver test node

* Update links to mytonctrl master

---------

Co-authored-by: Full-Hat <[email protected]>

* Add .NET ton_proof demo (#723)

* Add information about api keys (#729)

* Add information about api keys

* Remove info about tariffs

---------

Co-authored-by: Full-Hat <[email protected]>

* added translation (#752)

* Update analysis link (#674)

* Update analysis link

* Fix link

* Add eth 2.0 info

* Remove Eth 1.0 & update ton name

---------

Co-authored-by: Full-Hat <[email protected]>

* node-commands_added

* Fixed cases with 16 flag in modes cookbook (#754)

Co-authored-by: Vladislav Kokosh <[email protected]>

* Docu update on MacOS installation and docker image with MyTonCtrl 2.0 (#755)

* update ton installation on MacOS

* update docker with MyTonCtrl 2.0 docu

---------

Co-authored-by: neodiX <[email protected]>

* cut-ecosystem-sap

* Update governance.md

* lite-client-naming

* Update sign.mdx (#760)

added convenient check if proof valid

* nodes_documentation_fine_update (#762)

* nodes_documentation_fine_update

* added_wallet_deployment_for_each_shard

* added_mintless_jettons

* beauty_fixes

* beauty_fixes_2

* build_fix

* fix_node_reqierements

* node_reqierement_fix.mdx

* fix_node_reqierements_2

* fix_node_reqierements_3

* wallet_v5_caution_cut

* feat: clarified jetton errors information (#771)

Co-authored-by: Aliaksandr Bahdanau <[email protected]>

* Add Chainstack as node & indexer provider (#774)

* Update_node_reqierements

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Full-Hat <[email protected]>
Co-authored-by: Aliaksandr Bahdanau <[email protected]>
Co-authored-by: Andrey Semenov <[email protected]>
Co-authored-by: AlexG <[email protected]>
Co-authored-by: Maksim Kurbatov <[email protected]>
Co-authored-by: Vladislav Kokosh <[email protected]>
Co-authored-by: TonSquare <[email protected]>
Co-authored-by: Igor Golodnitsky <[email protected]>
Co-authored-by: Ryan Holanda <[email protected]>
Co-authored-by: Victor S <[email protected]>
Co-authored-by: sansx <[email protected]>
Co-authored-by: sansx <[email protected]>
Co-authored-by: omahs <[email protected]>
Co-authored-by: “mlikhar” <[email protected]>
Co-authored-by: Antonoff <[email protected]>
Co-authored-by: p.nazarychev <[email protected]>
Co-authored-by: Airam G <[email protected]>
Co-authored-by: Oleg Baranov <[email protected]>
Co-authored-by: Anthony Tsivarev <[email protected]>
Co-authored-by: 70sh1 <[email protected]>
Co-authored-by: igor <[email protected]>
Co-authored-by: Ginta <[email protected]>
Co-authored-by: PixelPlex Dev team <[email protected]>
Co-authored-by: infinityspectra <[email protected]>
Co-authored-by: NakeyJakey <[email protected]>
Co-authored-by: Devin <[email protected]>
Co-authored-by: Duginets Nikita <[email protected]>
Co-authored-by: Roman <[email protected]>
Co-authored-by: Sergey Andreev <[email protected]>
Co-authored-by: Dr. Awesome Doge <[email protected]>
Co-authored-by: Victor <[email protected]>
Co-authored-by: vityooook <[email protected]>
Co-authored-by: aSpite <[email protected]>
Co-authored-by: zhangchitc <[email protected]>
Co-authored-by: SilentPine <[email protected]>
Co-authored-by: spookyahell <[email protected]>
Co-authored-by: Full-Hat <[email protected]>
Co-authored-by: lotteam003 <[email protected]>
Co-authored-by: lotteam003 <[email protected]>
Co-authored-by: blockchaingirl1407 <[email protected]>
Co-authored-by: Moiseev Ilya <[email protected]>
Co-authored-by: Andrey Tvorozhkov <[email protected]>
Co-authored-by: Artem <[email protected]>
Co-authored-by: Shon Ness <[email protected]>
Co-authored-by: Alexander <[email protected]>
Co-authored-by: StarryHazex <[email protected]>
Co-authored-by: neodix42 <[email protected]>
Co-authored-by: neodiX <[email protected]>
Co-authored-by: EmelyanenkoK <[email protected]>
Co-authored-by: JeanClaude (JC) <[email protected]>
Co-authored-by: Ake <[email protected]>
  • Loading branch information
Show file tree
Hide file tree
Showing 733 changed files with 135,055 additions and 14,998 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 2
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
./.docusaurus
./build
./node_modules
15 changes: 15 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// .eslintrc.js example
module.exports = {
env: {
browser: true,
es2021: true
},
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: "latest",
sourceType: "module"
},
rules: {
indent: ["error", 2]
}
}
18 changes: 2 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature request
name: Docs feature request
description: Suggest an idea for this project
title: Feature request
title: Docs feature request
labels: ["feature :sparkles:"]
body:
- type: textarea
Expand All @@ -17,22 +17,8 @@ body:
description: A clear and concise description of what you want to happen
validations:
required: true
- type: textarea
id: feature_request_alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered
validations:
required: true
- type: textarea
id: feature_request_additional_context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here
- type: markdown
attributes:
value: |
**Want to contribute?**
- type: markdown
attributes:
value: We love contributions from the TON community! Please comment on an issue if you're interested in helping out with a PR.
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- i18n/**/*

"documentation :book:":
- README.md
- academy-overview.md

"tooling :wrench:":
- .github/**/*
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Lint

on: pull_request

jobs:
eslint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
- run: npm ci # or yarn install
- uses: sibiraj-s/action-eslint@v3
with:
token: ${{ secrets.GITHUB_TOKEN }} # optional
ignore-path: .eslintignore
extensions: 'js,jsx,ts,tsx'
annotations: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.gitpod.yml

.env
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This is the official repository for The Open Network documentation.

Latest documentation release: [docs.ton.org](https://docs.ton.org)

The mission of this documentation is to collect all available information and knowledge that can help TON developers.

You can improve the documentation by following steps below.
Expand All @@ -21,7 +21,7 @@ TON is an actively growing ecosystem, and every day many devs contribute to its
You can participate in TON by helping organize knowledge, making Pull Requests and creating tutorials to help other developers.
Feedback, lectures, technical articles, tutorials, and examples. All this can help the developers community grow even faster!

Join TON Docs Club chat in Telegram and get the latest tasks from maintainers:
Join TON Docs Club chat in Telegram to join contributors party:
* https://t.me/+c-0fVO4XHQsyOWM8

---
Expand All @@ -30,12 +30,11 @@ Join TON Docs Club chat in Telegram and get the latest tasks from maintainers:

## How to Contribute? 🦄

As said before, it's up to you.

If you are a developer and faced some difficulties, successfully overcoming them - share this knowledge with future developers!

— Have an idea? [Submit an issue](https://github.com/ton-community/ton-docs/issues/new/choose).
— Want to validate changes? [Setup your environment](https://github.com/ton-community/ton-docs#set-up-your-environment-%EF%B8%8F).
— Have an issue? [Prepare a solution with TON Docs Wizard](https://t.me/ton_docs_bot).
— Have an idea? [Submit a Feature Request](https://github.com/ton-community/ton-docs/issues/new/choose).
— Want to contribute? [Setup your environment](https://github.com/ton-community/ton-docs#set-up-your-environment-%EF%B8%8F).

Contributing best practices: [docs/contribute](https://ton.org/docs/contribute)

Expand Down Expand Up @@ -68,9 +67,25 @@ Use Gitpod (a free, online VS code-like IDE) for contributing. It will launch a
```
npm run start
```
6. Build with multiple locales and run it locally

```
npm run build
npm run serve
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Contributors Wall
<a href="https://github.com/ton-community/ton-docs/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ton-community/ton-docs&max=204" />
</a>

<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
↑ Back to Top ↑
</a>
</p>
## License

[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)
Expand Down
12 changes: 12 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
project_id: '663652'
api_token_env: CROWDIN_PERSONAL_TOKEN
preserve_hierarchy: 1
files:
- source: /i18n/en/**/*
translation: /i18n/%two_letters_code%/**/%original_file_name%
- source: /docs/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
ignore:
- /docs/**/*.png
- source: /src/pages/learn/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-pages/learn/**/%original_file_name%
2 changes: 1 addition & 1 deletion deployment/Docker/nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ server {
server_name _;

location / {
root /app;
root /app;
try_files $uri $uri/index.html $uri.html 404.html;
}
}
34 changes: 23 additions & 11 deletions docs/contribute/archive/hacktoberfest-2022/README.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import Button from '@site/src/components/button'

# What is Hacktoberfest?

````mdx-code-block
<div style={{ textAlign: 'center', margin: '50px 0' }}>
<img alt="tlb structure"
src="/docs/img/docs/hacktoberfest.webp"
width="100%" />
</div>

````
[Hacktoberfest](https://hacktoberfest.digitalocean.com/) is a month-long celebration of *open-source projects*, their *maintainers*, and the entire community of *contributors*. Each October, open source maintainers give new contributors extra attention as they guide developers through their first pull requests.

For the TON Community it's time to help ecosystem growth together, so let's join the whole world with our **Hack-TON-berfest** party and become *#1 open-source ecosystem of the year*!
Expand All @@ -30,14 +30,16 @@ For everyone in TON it's an opportunity to drive the growth of the entire ecosys
## What are the rewards?

To motivate the community to contribute to open source projects in the TON Ecosystem, you'll be able to receive a special reward from TON Foundation. Every participant will receive a **Limited Hack-TON-berfest NFT** achievement as a proof of participating:

<div style={{textAlign:'center', margin: '0 auto'}}>
<video width="300" style={{borderRadius:'10pt', margin:'15pt auto'}} muted={true} autoPlay={true} loop={true}>
````mdx-code-block
<div style={{width: '100%', textAlign:'center', margin: '0 auto'}}>
<video width="300" style={{width: '100%', borderRadius:'10pt', margin:'15pt auto'}} muted={true} autoPlay={true} loop={true}>
<source src="/docs/files/nft-sm.mp4" type="video/mp4" />
Your browser does not support the video tag.
````
Your browser does not support the video tag.
````mdx-code-block
</video>
</div>

````
:::info IMPORTANT!
TON Foundation will mint a collection in November to all wallet addresses submitted to the [@toncontests_bot](https://t.me/toncontests_bot). It will happen after the calculation and validation of all contribution results.
:::
Expand All @@ -46,8 +48,18 @@ You have plenty of time to participate in the event. Let's build decentralized I



<Button href="/contribute/hacktoberfest/as-contributor"
````mdx-code-block
<Button href="/contribute/hacktoberfest/as-contributor"
colorType="primary" sizeType={'lg'}>
I want to become a Contributor
</Button>
<Button href="/contribute/hacktoberfest/as-maintainer" colorType={'secondary'} sizeType={'lg'}>I'm a Maintainer</Button>
````
I want to become a Contributor
````mdx-code-block
</Button>
````
````mdx-code-block
<Button href="/contribute/hacktoberfest/as-maintainer" colorType={'secondary'} sizeType={'lg'}>
````
I'm a Maintainer
````mdx-code-block
</Button>
````
92 changes: 92 additions & 0 deletions docs/contribute/docs/schemes-guidelines.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import ConceptImage from '@site/src/components/conceptImage';
import ThemedImage from '@theme/ThemedImage';

# Graphic Explanations Guidelines

Maintaining consistency in documentation is crucial, and to achieve this, a specific standard for visualizing processes in smart contracts has been developed.

## Graphic Explanation Notation

### Message Processing Graph

To depict message processing, it's advisable to utilize a graphical representation resembling a smart contract graph, complete with labels for transactions and messages.

If the order of transactions doesn't matter, you can omit their labels. This simplifies the diagram, making it easier to read and understand the details related to messages and contracts.

#### Annotation Primitives

|Figure|Description|
|------|-----------|
|![](/img/docs/scheme-templates/message-processing-graphs/circle_for_smart_contract.svg?raw=true) | Circle - Smart Contract entity |
|![](/img/docs/scheme-templates/message-processing-graphs/rectangle_for_regular_message.svg?raw=true) | Rectangle - Message Entity |
|![](/img/docs/scheme-templates/message-processing-graphs/dashed_rectgl_for_optional_message.svg?raw=true) | Dashed Rectangle - Optional Message Entity |
|![](/img/docs/scheme-templates/message-processing-graphs/line_for_transaction.svg?raw=true) | Transactions (numeration optional)|
|![](/img/docs/scheme-templates/message-processing-graphs/person_figure_for_actor.svg?raw=true) | Actor|

* Avoid using big quantity different and bright colors.
* Use the modification of figures, such as using a dashed border line.
* For better comprehension, different transactions could be displayed with distinct line styles (solid and dashed).


#### Message Processing Example
````mdx-code-block
<br></br>
<ThemedImage
alt=""
sources={{
light: '/img/docs/message-delivery/message_delivery_2.svg?raw=true',
dark: '/img/docs/message-delivery/message_delivery_2.svg?raw=true',
}}
/>
<br></br>
````


Learn references directly from Visio [message-processing.vsdx](/static/schemes-visio/message-processing.vsdx).


### Formats and Colors

#### Fonts

* **Inter** fonts family for all text within diagrams.

#### Colors - Light Mode
* Pencil Hand Drawn(default theme)

#### Colors - Dark Mode
* Font `#e3e3e3`
* Background `#232328`
* Light Highlight(arrows and scheme borders) `#058dd2`
* Dark Highlight(arrows and scheme borders) `#0088cc`
* InnerBackGround(for nested blocks) `#333337`


#### Version Control Policy

* Set diagrams in the documentation by SVG format for schemes to ensure readability on various devices.
* Store original files in the project's Git repository under the "/static/visio" directory, making them easier to modify in the future.


### Sequence Diagram
In the case of complex and repetitive communication schemes between 2-3 actors, it is advisable to use a sequence diagram. For messages, use the notation of a common synchronous message arrow.

#### Example
````mdx-code-block
<br></br>
<div class="text--center">
<ThemedImage
alt=""
sources={{
light: '/img/docs/message-delivery/message_delivery_7.svg?raw=true',
dark: '/img/docs/message-delivery/message_delivery_7.svg?raw=true',
}}
/>
</div>
<br></br>
````

### Scheme References

* [message-processing.vsdx](/schemes-visio/message_processing.vsdx)

Loading

0 comments on commit 826ab0a

Please sign in to comment.