Improve experience for really long settings descriptions

[Tyriar]

After #66179 😱

Some options:

• Have a read more button when things get too long
• Have string that appear only in the JSON/intellisense

[roblourens]

I want to add JSON schema properties, uiDescription and uiMarkdownDescription, which will let us override the normal description for just the settings UI. The description with the full list will still show up in the JSON editor and the suggest widget. Thoughts on that @aeschli?

I think that in the future we could have a control that would let us show the default value in a better way in the UI editor.

I don't really like the "read more" button as a one-off workaround for this setting.

[aeschli]

@roblourens Can't we find a (markdown)description that works in both UI and intellisense?
IMO we can tune the settings descriptions for the UI, the intellisense experience is now less important

[Tyriar]

@aeschli the full list needs to be accessible somewhere so that users know what to add/remove, adding this to the website would be awkward as it changes between versions and would need to be updated manually. The separate descriptions proposed makes sense here because you can't even edit the setting in the UI.

@roblourens how about a truncateMarkdownDescription: boolean flag instead which truncates after x characters on the UI?

[roblourens]

How about I just always truncate after x newline characters and add a [...] rather than an expand button. And counting newlines instead of figuring out wrapped lines. That should only impact this one setting.

[Tyriar]

@roblourens great idea 👍

[tiliv]

Hey all, I'm finding this change really complicated to deal with. When I copy the default setting to put in my own, it's empty, so the truncation makes this a very confusing setting to work with.

Am I missing something about the intended interaction with this setting's value?

[roblourens]

You only need to add settings that you want to add or remove from the list. If you want to see the full list for reference, you should be able to see the full list when you hover the setting name in the json editor.