Skip to content

Conversation

fakela
Copy link
Contributor

@fakela fakela commented Oct 9, 2025

This whitepaper has four references cited.

Added links for references [3] and [4], as those were missing.
Reference [4] is mentioned 25 times, and [3] is mentioned 5 times. The other references ([1] and [2]) are each mentioned 3 times.

Reference [4] links to both the 2017 and 2018 TVM documents.

I have also attached an external link to the reference N. Durov, “Telegram Open Network,” 2017 and 2018, for easier access.

Closes issue: #559

@fakela fakela linked an issue Oct 9, 2025 that may be closed by this pull request
Copy link

github-actions bot commented Oct 9, 2025

Thanks for the updates in ton/tblkch.mdx. Two quick, high-priority doc fixes are needed before merge.

Findings (2)

High (2)

[HIGH] Broken anchor link to non-existent “Chapter 5”

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/ffd135f8d54349771786eb544e0be5d5c82b079c/ton/tblkch.mdx?plain=1#L18-L18

Description:
The change adds a link to “Chapter 5”, but this file has no heading that would generate the #5-block-layout anchor. Only Chapter 5 subsection headings exist (e.g., “## 5.1”, “## 5.2”, “## 5.3”), so the link target is unresolved. Broken/missing anchors are a release‑blocking violation per https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L31-L31.

Suggestion:
Remove the broken link and keep “Chapter 5” as plain text.

- ... culminating in a complete description of the TON Blockchain (shardchain and masterchain) block layout in [Chapter 5](#5-block-layout).
+ ... culminating in a complete description of the TON Blockchain (shardchain and masterchain) block layout in Chapter 5.

[HIGH] Literals not formatted as code

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/ffd135f8d54349771786eb544e0be5d5c82b079c/ton/tblkch.mdx?plain=1#L38-L38

Description:
The PR removed code formatting for numeric literals in the sentence about TVM cells (“1023” and “four/4”). The style guide requires code formatting for literals to preserve precision and copy‑paste fidelity (https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L268-L271). Leaving these as plain text reduces clarity and increases the chance of transcription errors.

Suggestion:
Restore code formatting for the numeric values.

- Recall that the TON Blockchain, as well as the TON Virtual Machine (TVM; cf. [4](#ref-4)), represents all permanently stored data as a collection or bag of so-called cells. Each cell consists of up to 1023 data bits and up to four references to other cells. Cyclic cell references are not allowed, so the cells are usually organized into trees of cells, or rather directed acyclic graphs (DAGs) of cells.[³](#footnote-3) Any value of an abstract algebraic (dependent) data type may be represented (serialized) as a tree of cells. 
+ Recall that the TON Blockchain, as well as the TON Virtual Machine (TVM; cf. [4](#ref-4)), represents all permanently stored data as a collection or bag of so-called cells. Each cell consists of up to `1023` data bits and up to `4` references to other cells. Cyclic cell references are not allowed, so the cells are usually organized into trees of cells, or rather directed acyclic graphs (DAGs) of cells.[³](#footnote-3) Any value of an abstract algebraic (dependent) data type may be represented (serialized) as a tree of cells. 

@fakela fakela self-assigned this Oct 9, 2025
@fakela fakela requested a review from anton-trunov October 9, 2025 02:12
@fakela
Copy link
Contributor Author

fakela commented Oct 9, 2025

PS: Ignore the github actions suggestions its wrong and ndoesn't fit current scope

Copy link
Collaborator

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please redo all the links to concrete sections, see the details in-place

@reveloper
Copy link
Collaborator

@fakela here's example, how should we make crosslink:

  1. All external links related to Telegram Open Network should direct to the corresponding The Open Network page instead of footnotes [cf 4].
Screenshot 0007-10-10 at 16 40 21
  1. Add clarification foot note, that we made this change, at least for the first one:
Screenshot 0007-10-10 at 16 41 21
  1. Make the direct internal link for TVM page corresponded sections instead of footnotes. I also included in the link text the chapter digits. For instance, the link text from 3, became 3, A .
Screenshot 0007-10-10 at 16 40 45

Let's spread this updated within other pages ASAP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cross-link tblkch.pdf

4 participants