-
Notifications
You must be signed in to change notification settings - Fork 1
add overview page for blockchain foundation #455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Thanks for the updates to the TON docs, especially in ton/overview.mdx. A few items need fixes for links, headings, and terminology before merge. Findings (10)High (2)[HIGH] Missing H1 at top of pageDescription: Suggestion: @@
-This section introduces the core concepts of the TON Blockchain. It explains the fundamental building blocks of the system, including data structures, transaction flow, consensus mechanisms, and network protocols.
+# Overview
+This section introduces the core concepts of the TON Blockchain. It explains the fundamental building blocks of the system, including data structures, transaction flow, consensus mechanisms, and network protocols. [HIGH] Broken or incorrect internal linksDescription: Suggestion: - - **[Cells](/ton/cells)** – TON’s universal data structure, used to represent every piece of information on-chain, from account states to transactions, in a compact and hash-friendly format.
+ - **[Cells](/ton/cells/boc)** – TON’s universal data structure, used to represent every piece of information on-chain, from account states to transactions, in a compact and hash-friendly format.
- - **[Addresses](/ton/addresses)** – The scheme TON uses to uniquely identify accounts and smart contracts across workchains and shardchains, with built-in error detection.
+ - **[Addresses](/ton/addresses/addresses-general-info)** – The scheme TON uses to uniquely identify accounts and smart contracts across workchains and shardchains, with built-in error detection.
- - **[Blocks](/ton/)** – The structure of TON blocks, which record the results of transactions and link shardchains together through cryptographic proofs.
+ - **[Blocks](/ton/tbl)** – The structure of TON blocks, which record the results of transactions and link shardchains together through cryptographic proofs.
- - **[TVM Whitepaper](/ton/wtvm)** – The original specification of the TON Virtual Machine, the execution engine for all smart contracts.
+ - **[TVM Whitepaper](/ton/tvm)** – The original specification of the TON Virtual Machine, the execution engine for all smart contracts. Medium (5)Click to expand[MEDIUM] Headings not in sentence case (and ampersand)Description: Suggestion: -## Core Data Structures & Addressing
+## Core data structures and addressing
-## Transaction Processing
+## Transaction processing
-## Network Architecture
+## Network architecture
-## Validation & Security
+## Validation and security
-## Technical Whitepapers
+## Technical whitepapers
-## Reference Materials
+## Reference materials [MEDIUM] Weak opener and missing acronym expansionDescription: Suggestion: -This section introduces the core concepts of the TON Blockchain. It explains the fundamental building blocks of the system, including data structures, transaction flow, consensus mechanisms, and network protocols.
+Core concepts of The Open Network (TON): data structures, transaction flow, consensus, and networking. [MEDIUM] Acronyms (ADNL, RLDP, DHT) not expanded on first mentionDescription: Suggestion: - - **[Network Protocols](/ton/network)** – TON’s communication stack, including ADNL for peer discovery, RLDP for reliable data transfer, and DHT for distributed lookups.
+ - **[Network Protocols](/ton/network)** – TON’s communication stack, including Abstract Datagram Network Layer (ADNL) for peer discovery, Reliable Large Datagram Protocol (RLDP) for reliable data transfer, and distributed hash table (DHT) for distributed lookups. [MEDIUM] BFT acronym used before definitionDescription: Suggestion: - - **[Consensus](/ton/consensus)** – TON’s Catchain consensus protocol, a Byzantine Fault Tolerant algorithm that ensures validators reach agreement on blocks in the presence of faulty or malicious participants.
+ - **[Consensus](/ton/consensus)** – TON’s Catchain consensus protocol, a Byzantine fault-tolerant (BFT) algorithm that ensures validators reach agreement on blocks in the presence of faulty or malicious participants. [MEDIUM] Non‑canonical casing for WorkChain/ShardChainDescription: Suggestion: - - **[Addresses](/ton/addresses/addresses-general-info)** – The scheme TON uses to uniquely identify accounts and smart contracts across workchains and shardchains, with built-in error detection.
+ - **[Addresses](/ton/addresses/addresses-general-info)** – The scheme TON uses to uniquely identify accounts and smart contracts across WorkChains and ShardChains, with built-in error detection.
@@
- - **[Blockchain Sharding](/ton/shards)** – TON’s horizontal scaling model, where every workchain is divided into multiple shardchains that can process transactions in parallel.
+ - **[Blockchain Sharding](/ton/shards)** – TON’s horizontal scaling model, where every WorkChain is divided into multiple ShardChains that can process transactions in parallel.
@@
- - **[Blocks](/ton/tbl)** – The structure of TON blocks, which record the results of transactions and link shardchains together through cryptographic proofs.
+ - **[Blocks](/ton/tbl)** – The structure of TON blocks, which record the results of transactions and link ShardChains together through cryptographic proofs. Low (3)Click to expand[LOW] Generic capitalization and missing hyphen in “Byzantine fault‑tolerant”Description: Suggestion: - - **[Consensus](/ton/consensus)** – TON’s Catchain consensus protocol, a Byzantine Fault Tolerant algorithm that ensures validators reach agreement on blocks in the presence of faulty or malicious participants.
+ - **[Consensus](/ton/consensus)** – TON’s Catchain consensus protocol, a Byzantine fault‑tolerant algorithm that ensures validators reach agreement on blocks in the presence of faulty or malicious participants. [LOW] Mid‑sentence capitalization in link textDescription: Suggestion: - - **[Blockchain Sharding](/ton/shards)** – TON’s horizontal scaling model, where every workchain is divided into multiple shardchains that can process transactions in parallel.
+ - **[Blockchain sharding](/ton/shards)** – TON’s horizontal scaling model, where every workchain is divided into multiple shardchains that can process transactions in parallel.
- - **[Node Configuration](/ton/config)** – The setup of different TON node types, such as validators, liteservers, and full nodes, and how they cooperate to maintain the network.
+ - **[Node configuration](/ton/config)** – The setup of different TON node types, such as validators, liteservers, and full nodes, and how they cooperate to maintain the network.
- - **[Network Protocols](/ton/network)** – TON’s communication stack, including ADNL for peer discovery, RLDP for reliable data transfer, and DHT for distributed lookups.
+ - **[Network protocols](/ton/network)** – TON’s communication stack, including ADNL for peer discovery, RLDP for reliable data transfer, and DHT for distributed lookups. [LOW] Prefer relative internal linksDescription: Suggestion: - - **[Messages and Transactions](/ton/transaction)** – TON is message-driven: all interactions between accounts are handled through internal and external messages, which together form transactions.
+ - **[Messages and transactions](transaction)** – TON is message-driven: all interactions between accounts are handled through internal and external messages, which together form transactions.
- - **[Execution Phases and Fees](/ton/phases-and-fees)** – How TON processes a transaction through the Storage, Credit, Compute, Action, and Bounce phases, while applying gas and storage fees at each step.
+ - **[Execution phases and fees](phases-and-fees)** – How TON processes a transaction through the Storage, Credit, Compute, Action, and Bounce phases, while applying gas and storage fees at each step.
- - **[Precompiled Contracts](/ton/precompiled)** – Special smart contracts built into the TON protocol, optimized for frequently used cryptographic and system operations.
+ - **[Precompiled contracts](precompiled)** – Special smart contracts built into the TON protocol, optimized for frequently used cryptographic and system operations. |
@fakela There is a LOT of inaccuracies in this article. I will fix all of them right here in your PR and merge. Please do not vibecode more) |
This PR closes #51