XRPLF / clio

An XRP Ledger API Server
https://xrpl.org
ISC License
55 stars 47 forks source link

Add descriptive info about various fields of Clio config. #1460

Open mounikakun opened 2 weeks ago

mounikakun commented 2 weeks ago

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

godexsoft commented 1 week ago

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? 🙇