OpenCloud
/
riot-web
mirror of https://github.com/vector-im/riot-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Write out docs explicitly.

pull/16890/head
Travis Ralston 2021-04-12 14:59:56 -06:00
parent bd38ad5166
commit 1de7828e4d
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/config.md
View File

@ -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.