Release Notes:
- N/A
---
I'd like to help improve Configuration documentation.
Currently I'm often confused by the configuration doc. It's incomplete:
not all settings are documented. It's disorganized: some options are
grouped together but overall there's not much structure or logic to it.
It's inconsistent: some examples show only key and value, some—just the
closes object, and others full nesting. It's confusing: individual keys
are listed but it's hard to understand where in the config structure
they belong.
I suggest the following changes:
- Always specify the full path of the setting
- Document all settings Zed recognises
- List settings in alphabetical order of their full path
- Always use full nesting in examples
This is an example, of what it might look like. It's first draft, too.
So I'm open to suggestions.
Please let me know if you're interested in this. The whole thing might
need a bit of effort so I'd like to know if this is something you might
want before doing all the work.
---------
Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com>
