sbt-how-it-works #494
sbt-how-it-works #494
Conversation
Shvandre
left a comment
Shvandre
left a comment
There was a problem hiding this comment.
Let's add some code examples from SBT implementation
|
To fix the formatting issues:
npx remark -o --quiet --silently-ignore standard/tokens/sbt/how-works.mdx |
verytactical
left a comment
verytactical
left a comment
There was a problem hiding this comment.
By the time article explains how to "prove ownership", I still have no idea what am I proving ownership of. The article is supposed to explain how SBTs work.
Code samples requested above can actually be separated into "how to" articles.
|
Please fill out PR title and description. |
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore standard/tokens/sbt/how-works.mdx |
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore standard/tokens/sbt/how-it-works.mdx |
anton-trunov
left a comment
anton-trunov
left a comment
There was a problem hiding this comment.
let's fix the overview page too
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore guides/from-ethereum.mdx standard/tokens/nft/comparison.mdx standard/tokens/sbt/how-it-works.mdx |
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore guides/from-ethereum.mdx standard/tokens/nft/comparison.mdx standard/tokens/overview.mdx standard/tokens/sbt/how-it-works.mdx |
|
let update it after merging #743 ( in this PR I should add info for NFT API page ) |
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore from-ethereum.mdx standard/tokens/nft/comparison.mdx standard/tokens/overview.mdx standard/tokens/sbt/how-it-works.mdx |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
standard/tokens/nft/sbt.mdx
Outdated
| import { Aside } from '/snippets/aside.jsx'; | ||
|
|
||
| <Stub issue="104" /> | ||
| This article describes the basic ideas and processes behind the implementation of SBT (Soul-Bound Token) in the TON Blockchain. |
There was a problem hiding this comment.
[HIGH] Throat‑clearing opener (“This article describes …”)
The opener describes the document instead of delivering value, which violates the style rule against throat‑clearing introductions. Starting with a direct, purpose‑first line improves scannability and clarity. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L185-L189 for the normative guidance.
| This article describes the basic ideas and processes behind the implementation of SBT (Soul-Bound Token) in the TON Blockchain. | |
| SBT on TON: data storage and message flows. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
standard/tokens/nft/sbt.mdx
Outdated
| <Aside | ||
| type="caution" | ||
| > | ||
| In all schemes below you will see the `query_id` field. Nowadays the field is almost deprecated, and protocols themselves don't need it. It is mostly used for easier off-chain parsing and other web2 processing. |
There was a problem hiding this comment.
[HIGH] Second‑person (“you will see”) in caution Aside
The caution Aside addresses the reader directly (“you will see”), which the style guide prohibits to keep language neutral and factual. Replace second‑person phrasing with an impersonal construction while preserving meaning. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L172.
| In all schemes below you will see the `query_id` field. Nowadays the field is almost deprecated, and protocols themselves don't need it. It is mostly used for easier off-chain parsing and other web2 processing. | |
| All schemes below include the `query_id` field. Nowadays the field is almost deprecated, and protocols themselves don't need it. It is mostly used for easier off-chain parsing and other web2 processing. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
standard/tokens/nft/sbt.mdx
Outdated
| end | ||
| ``` | ||
|
|
||
| This message flow allows the `owner` to ask the SBT to send a proof to a target contract confirming that they own this SBT. You may include arbitrary `forward_payload` and optionally attach `content`. |
There was a problem hiding this comment.
[HIGH] Second‑person (“You may include …”) in prose
This sentence speaks to the reader directly (“You may include …”), which the style guide forbids. Use a neutral, impersonal instruction to align with house style while keeping the content unchanged. See https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L169-L172.
| This message flow allows the `owner` to ask the SBT to send a proof to a target contract confirming that they own this SBT. You may include arbitrary `forward_payload` and optionally attach `content`. | |
| This message flow allows the `owner` to ask the SBT to send a proof to a target contract confirming that they own this SBT. Include arbitrary `forward_payload` and optionally attach `content`. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
|
To fix the formatting issues:
npx remark -o --silent --silently-ignore standard/tokens/nft/comparison.mdx standard/tokens/nft/sbt.mdx |
Closes #104