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

[DOCS] Add more detail on "Configuration Options" pages. #750

Open
ZakAyesh opened this issue Jun 17, 2024 · 0 comments
Open

[DOCS] Add more detail on "Configuration Options" pages. #750

ZakAyesh opened this issue Jun 17, 2024 · 0 comments
Labels
community-request docs updates requested by community or OP collective configuration config options, config files documentation Improvements or additions to documentation labs-internal-request internal request labs (non devrel)

Comments

@ZakAyesh
Copy link
Contributor

Brief Description of the Docs Request

For the two configuration options pages:

More detail must be given on the different configuration variables and their arguments. For example, more detail on exactly what the syncmode configuration variable does and what exactly changing it's argument does to the node.

Description of the Documentation You'd Like

We could add an extra tab to each variables description for more in-depth information on exactly when and how to use each configuration option and how that affects the operation of the node.

Links to Related Pages

Additional Context

Dev support was trying to help partners with configuration issues, but it was unclear even to us what side effects different configuration options may have to begin troubleshooting issue without relying on the engineers.

@ZakAyesh ZakAyesh added documentation Improvements or additions to documentation community-request docs updates requested by community or OP collective labels Jun 17, 2024
@cpengilly cpengilly added labs-internal-request internal request labs (non devrel) configuration config options, config files labels Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-request docs updates requested by community or OP collective configuration config options, config files documentation Improvements or additions to documentation labs-internal-request internal request labs (non devrel)
Projects
None yet
Development

No branches or pull requests

2 participants