From bf5a69d3a03c73a550eee3997f76b00c11cb203c Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Thu, 28 Jan 2021 17:28:49 +0000 Subject: [PATCH] Document the mobile guide toast option Part of https://github.com/vector-im/element-web/issues/16283 --- docs/config.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/config.md b/docs/config.md index 7dc4d6085f..f087af1848 100644 --- a/docs/config.md +++ b/docs/config.md @@ -122,6 +122,9 @@ For a good example, see https://develop.element.io/config.json. This option is experimental and may be removed at any time without notice. It's also strongly advised not to set this option unless you're absolutly certain you know what you're doing. +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. Note that `index.html` also has an og:image meta tag that is set to an image hosted on riot.im. This is the image used if links to your copy of Element