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

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

Open
mounikakun opened this issue Jun 12, 2024 · 1 comment · May be fixed by #1842
Open

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

mounikakun opened this issue Jun 12, 2024 · 1 comment · May be fixed by #1842
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@mounikakun
Copy link
Collaborator

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

@mounikakun mounikakun added the enhancement New feature or request label Jun 12, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Clio Jun 12, 2024
@mounikakun 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
@godexsoft
Copy link
Collaborator

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

@godexsoft godexsoft added this to the 2.3 milestone Jun 17, 2024
@godexsoft godexsoft modified the milestones: 2.3, 2.4 Oct 21, 2024
@PeterChen13579 PeterChen13579 linked a pull request Jan 21, 2025 that will close this issue
@maria-robobug maria-robobug self-assigned this Jan 22, 2025
@maria-robobug maria-robobug moved this from 📋 Backlog to 🏗 In progress in Clio Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🏗 In progress
Development

Successfully merging a pull request may close this issue.

3 participants