mirror of
https://github.com/vector-im/element-web.git
synced 2024-09-10 07:05:14 +00:00
Write out docs explicitly.
This commit is contained in:
parent
bd38ad5166
commit
1de7828e4d
1 changed files with 7 additions and 4 deletions
|
@ -119,10 +119,13 @@ For a good example, see https://develop.element.io/config.json.
|
||||||
1. `mobileBuilds`: Used to alter promotional links to the mobile app. By default the
|
1. `mobileBuilds`: Used to alter promotional links to the mobile app. By default the
|
||||||
builds are considered available and accessible from https://element.io. This config
|
builds are considered available and accessible from https://element.io. This config
|
||||||
option is typically used in a context of encouraging the user to try the mobile app
|
option is typically used in a context of encouraging the user to try the mobile app
|
||||||
instead of a mobile/incompatible browser. There are 3 possible fields for this config
|
instead of a mobile/incompatible browser.
|
||||||
option: `ios`, `android`, `fdroid`. For all 3, when set to a string then that URL will
|
1. `ios`: The URL to the iOS build. If `null`, it will be assumed to be not available.
|
||||||
be used. When not defined, the default element.io apps will be used. When explicitly
|
If not set, the default element.io builds will be used.
|
||||||
set to `null`, that platform will be considered unavailable.
|
1. `android`: The URL to the Android build. If `null`, it will be assumed to be not available.
|
||||||
|
If not set, the default element.io builds will be used.
|
||||||
|
1. `fdroid`: The URL to the FDroid build. If `null`, it will be assumed to be not available.
|
||||||
|
If not set, the default element.io builds will be used.
|
||||||
1. `mobileGuideToast`: Whether to show a toast a startup which nudges users on
|
1. `mobileGuideToast`: Whether to show a toast a startup which nudges users on
|
||||||
iOS and Android towards the native mobile apps. The toast redirects to the
|
iOS and Android towards the native mobile apps. The toast redirects to the
|
||||||
mobile guide if they accept. Defaults to false.
|
mobile guide if they accept. Defaults to false.
|
||||||
|
|
Loading…
Reference in a new issue