[Feature Request] improve documentation and description for each option in each source

[bb-Ricardo]

What is the feature?

• The config options for each source should be well documented.
• The documentation should be part of the code (use struct for config option)
• configuration example with all possible options should be autogenerated on each release

Why is this feature important?

This would help:

1. keep track of which option is available for which source
2. improve documentation for the user which describes what each option exactly does
3. one single source of truth

How could this feature be implemented?

I'm actually not sure how to add descriptions of config options to structs which are then turned into config files. Have only seen it for kubebuilder which had a special comment format which then generated CRDs.

Have you considered alternatives?

No response

Additional context or references

No response

[bl4ko]

This would be a really handy feature. But I don't exactly know how to implement this.

The main problem is the design of the sources (parser.go), each source share the same options so that we can then easily parse this generically. For implementation of this feature the parser would need complete rewrite and I don't know how to rewrite parser in this fashion, since go is a statically typed language...