celestiaorg / celestiaorg/celestia-node

[Feature Request]: Add guideline comments into config.toml

Open
#514 1 comment 0 reactions 0 assignees View on GitHub
area:config documentation enhancement
Dominant language
Go
Stars
996
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
34

Description

### Summary

Add explanatory information inside config.toml

### Impact on users

ATM, users need to navigate to the networks repo in order to find a guideline on config.toml
Having all the explanatory info inside config.toml eases this step for future users

### Cost of not doing

Jumping back and forth from config.toml to networks repo guide is cumbersome

### Evidence

A lot of users are asking for explanatory information regarding config.toml without looking into the networks repo if they need to adjust the configs

### Implementation ideas

tendermint has done a good job for their config.toml

https://github.com/tendermint/tendermint/blob/master/config/config.go

https://github.com/tendermint/tendermint/commit/a057da6ab5d373caf15cfc0ee7be87f656e2576a

### Urgency

Medium

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.