From 1de7828e4dde308dc8af53153fade2a664314ddf Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 12 Apr 2021 14:59:56 -0600 Subject: [PATCH] Write out docs explicitly. --- docs/config.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index 3694ec00b1..27b4797f0c 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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 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 - instead of a mobile/incompatible browser. There are 3 possible fields for this config - option: `ios`, `android`, `fdroid`. For all 3, when set to a string then that URL will - be used. When not defined, the default element.io apps will be used. When explicitly - set to `null`, that platform will be considered unavailable. + instead of a mobile/incompatible browser. + 1. `ios`: The URL to the iOS build. If `null`, it will be assumed to be not available. + If not set, the default element.io builds will be used. + 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 iOS and Android towards the native mobile apps. The toast redirects to the mobile guide if they accept. Defaults to false.