Skip to content
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

Enhance config.yml for Better UX #3991

Open
salmad3 opened this issue Feb 26, 2024 · 0 comments
Open

Enhance config.yml for Better UX #3991

salmad3 opened this issue Feb 26, 2024 · 0 comments
Assignees
Labels
component:configs component:docs Documentation additions or improvements. type:enhancement Improvement or update to existing feature(s).
Milestone

Comments

@salmad3
Copy link
Contributor

salmad3 commented Feb 26, 2024

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 between config.yml and the blockchain's foundational settings.

  • Include timeout_commit Setting for Block Time Configuration: Explicitly add the timeout_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.

@salmad3 salmad3 added component:docs Documentation additions or improvements. component:configs type:enhancement Improvement or update to existing feature(s). labels Feb 26, 2024
@salmad3 salmad3 added this to the v29 milestone May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:configs component:docs Documentation additions or improvements. type:enhancement Improvement or update to existing feature(s).
Projects
Status: Todo
Development

No branches or pull requests

2 participants