feat(node): add global-config page#1901
Conversation
This comment has been minimized.
This comment has been minimized.
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| 1. Running a private network with custom DHT nodes and overlays. | ||
| 1. The bundled config is outdated. The official config may change over time, for example, updated DHT nodes or init blocks. Fetching a fresh copy periodically is recommended. | ||
|
|
||
| ## How to override |
There was a problem hiding this comment.
[HIGH] Missing safety callout for validator configuration changes
The “How to override” section at this location describes how to replace the node’s global.config.json (including validator parameters and networking configuration) via Helm and chart values, but it does not include a Caution/Warning <Aside> explaining risk, scope, environment, or rollback. Overriding globalConfig directly affects validator behavior and network connectivity; incorrect values can halt or desync validator nodes. The extended style guide requires safety callouts and explicit mitigation guidance for safety-critical actions such as modifying validator configuration (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L640-L667). A safety aside is needed here to set expectations about using testnet first and how to recover from misconfiguration.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## How to override | ||
|
|
There was a problem hiding this comment.
[HIGH] Missing safety callout for validator configuration changes
The “How to override” section introduces commands that download and pass a custom global.config.json to the node, which directly affects validator configuration and network parameters, but there is no nearby safety <Aside> callout. The extended style guide requires a Caution or Warning callout on any page or step that changes validator configuration, networking, or other consensus‑affecting settings, and it specifies that readers must be informed of risk, scope, mitigation/rollback, and testnet vs mainnet behavior. Without such a callout, users may apply mainnet configuration changes without clearly understanding the potential impact or how to recover from misconfiguration.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
2 participants
closes #1817