[FEATURE REQUEST] Default config.ron file with all the setting commented with explanations about configurations.

[thealio]

Describe the enhancement

Hi,
a good, in my opinion essential improvement to leftwm documentation should be to provide a better default config .ron file.
I think that it must include all the available commands and settings, with detailed comments about each command, its function and how to edit settings.

I ask that because, personally, I learn better how to configure things simply studying the configuration files , most of the time.

This should be useful for everyone : having a detailed default config.ron file to study, the user will avoid to ask lots of basilar questions on github , and the devs will consequentially save time .

How important is this enhancement to you?

My workflow is impaired without it

How important do you think is this enhancement for the average LeftWM user?

Their workflow is likely impaired without it

[Eskaan]

We currently auto-generate the config, that is why there is no explanation given, but I can definitely see the benefits of those comments.
related code | related issue | related wiki page

@VuiMuich is this a #good-first-issue ?

[VuiMuich]

Tbh, personally I am not a big fan of too verbose commented config files, but we could definitely ship a commented config with the examples. I'll open a PR in a minute to set the foundation for this.

[VuiMuich]

With the "Foundation" laid, PRs to comment on the config example in the will be welcom.

In the longrun it would be most useful, if we could dynamically generate the config comments from doc-comments in the code of each config option. I hope this is easily possibly, generally there are a bunch of projects doing very similar things iirc, so the question is "just" how feasible is it to implement.