Merge pull request #3046 from matrix-org/bwindels/settings-config-doc

document settingDefaults
2020-04-01 09:57:43 +00:00 · 2020-04-01 09:57:43 +00:00 · 775ba0f74e
parent 7ba6462a5d 66aea5eea5
commit 775ba0f74e
1 changed files with 11 additions and 0 deletions
--- a/docs/settings.md
+++ b/docs/settings.md
@ -51,6 +51,17 @@ Settings are the different options a user may set or experience in the applicati
 }
 ```

+Settings that support the config level can be set in the config file under the `settingDefaults` key (note that some settings, like the "theme" setting, are special cased in the config file):
+```json
+{
+  ...
+  "settingDefaults": {
+    "settingName": true
+  },
+  ...
+}
+```
+
 ### Getting values for a setting

 After importing `SettingsStore`, simply make a call to `SettingsStore.getValue`. The `roomId` parameter should always