csghub-server icon indicating copy to clipboard operation
csghub-server copied to clipboard

Add comments for each configuration item in config.toml.example

Open pulltheflower opened this issue 8 months ago • 1 comments

Background

As the number of configuration options in the configuration file increases, it is becoming harder for users and developers to understand the meaning and usage of each option. Currently, most configuration options in config.toml.example are not accompanied by comments or documentation.

What needs to be done

Gradually add clear and concise comments to each configuration item in config.toml.example.

Ensure that the comments explain the purpose and expected values (or value ranges) for each option.

Keep the comments consistent in style and formatting.

Optionally, update related documentation if necessary.

Why this is important

It improves the readability and maintainability of the configuration file.

It helps new users understand how to properly configure the application.

It reduces the risk of misconfiguration and related issues.

Additional Notes

Please follow the existing style if comments already exist for some options.

When adding comments, keep them short but informative.

pulltheflower avatar Apr 28 '25 08:04 pulltheflower