You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Lack of documentation or description about various fields of Clio config makes it ambiguous for the user to understand the purpose of the keys and customize their own values.
mounikakun
changed the title
Add descriptive info about various fields of Clio config2
Add descriptive info about various fields of Clio config.
Jun 12, 2024
For the first iteration it should be enough to produce an md file with each section and descriptions for each config option within those sections. @mDuo13 is this something you could help us with? 🙇
Summary
Currently there's no documentation or description about various fields of Clio config.
Feature request is to create a document or add more info about each key and acceptable values of Clio config in https://github.com/XRPLF/clio/blob/develop/docs/examples/config/example-config.json
Motivation
Lack of documentation or description about various fields of Clio config makes it ambiguous for the user to understand the purpose of the keys and customize their own values.
Solution
Add info about keys and acceptable values in example config.json similar to rippled.
Rippled example config: https://github.com/XRPLF/rippled/blob/develop/cfg/rippled-example.cfg
Paths Not Taken
The text was updated successfully, but these errors were encountered: