document settingDefaults

[bwindels]

See element-hq/element-web#6791 & element-hq/element-web#8449

Also element-hq/element-web#9919

[turt2live]

we should document this in the riot-web README (as per element-hq/element-web#6791) instead of the develop docs

[jryans]

@turt2live How about if we document it here and in riot-web?

[turt2live]

I have a fear that they'd get out of sync or forgotten about. Generally I try and consider riot-web to be the config side of things (despite the config being defined here) and the react-sdk being the logic layer.

I don't really mind if it's both, but at a minimum it should be in riot-web to help users.

[jryans]

Hmm, I guess I am confused... The PR here isn't trying to document each setting... It's just trying to mention that settings can be defaulted, which doesn't seem so likely to get out of sync, right? It's not likely to change unless we overhaul settings again.

[turt2live]

bleh, yes, that's true. The fact that the object exists though still makes most of my argument make sense, I think. The idea being that "hey, a flag exists for things" should be documented to riot admins and less so developers (ie: dump info in riot-web for riot admins, developer docs in react-sdk).

[bwindels]

This one seems to have been forgotten by me. I would go ahead and merge this if nobody objects as this is also already documented in riot-web/docs/config.md and in the sample config there. I think the information is also useful for developers though.

[turt2live]

lgtm otherwise

Sorry, this showed up at the bottom of my review queue which is often reserved for things that I'm ignoring or putting off ._.

[t3chguy]

@bwindels can we get this over the line :D?

[bwindels]

Not sure why all these tests are failing, but I am fairly sure it has nothing to do with these documentation changes, so merging.