tari-project / tari

The Tari protocol
https://tari.com
BSD 3-Clause "New" or "Revised" License
354 stars 219 forks source link

Review wording in first paragraph for the Base Node Configuration Options for configuration file created during installation. #6657

Open SolfataraEmit opened 3 weeks ago

SolfataraEmit commented 3 weeks ago

Describe the issue The paragraph explaining the Base Node Configuration Options (BaseNodeConfig) in the config file (config.toml) is at odds with the style and tone of the rest of the comments. I would recommend that the paragraph is reviewed and reworked to match the rest.

The paragraph currently reads:

# If you are not running a Minotari Base node, you can simply leave everything in this section commented out. Base nodes
# help maintain the security of the Minotari token and are the surest way to preserve your privacy and be 100% sure that
# no-one is cheating you out of your money.

Expected An explanation of what a base node is and what the configuration options below entail at a high-level.

# A Minotari base node is core to the network, providing several functions such as propogation, validation and management.
# These options configure how the base node operates (e.g. gRPC settings, database type, timeout periods, etc.)
# All base node configuration options can be commented out if you do not wish to run a base node.
# While users can use remote nodes, running your own base node adds resilience to the network, provides additional security, and direct access to the blockchain. 

Additional context This is in reference to the default config.toml file created by installing Tari Base Node binary for Mac from https://tari.com/downloads/