UPDATE: Enhance config.yml
for Better UX
#3991
Labels
component:configs
component:docs
Documentation additions or improvements.
type:enh
Improvement or update to existing feature(s).
Milestone
Context:
Originally shared interally by @toschdev
There are several areas for improvement in the
config.yml
file that could significantly enhance usability, especially for new users, as the file's current state may not provide enough guidance or clarity for developers.Potential Enhancements:
Add Default Ports Info: Include default ports for various network services directly in the
config.yml
file.Improve In-Line Comments: Ramp up the comments to provide clear explanations of what each setting does.
Link Critical Genesis Parameters: While the entire genesis file cannot be directly reflected in
config.yml
, including references or settings that influence key genesis parameters can help developers understand the relationship betweenconfig.yml
and the blockchain's foundational settings.Include
timeout_commit
Setting for Block Time Configuration: Explicitly add thetimeout_commit
setting (or its equivalent), complete with comments explaining its purpose and impact on blockchain performance. This addresses the common need to adjust the time between blocks.Define Token Exponents for Better Tokenomics Configuration: Provide a framework within
config.yml
for setting token exponents, denominations, and aliases. This would assist in configuring token representations more intuitively and ensure compatibility with external wallets and services.Other Options:
Customizable Configuration Templates: Develop a set of templates tailored to different types of apps, including pre-configured settings optimal for each application type, with detailed comments explaining each choice.
Community-Driven Examples: Reference community configurations for different use cases.
The text was updated successfully, but these errors were encountered: