Merge pull request #16301 from vector-im/jryans/maybe-mobile

Document the mobile guide toast option
2021-01-29 11:18:14 +00:00 · 2021-01-29 11:18:14 +00:00 · 8f0537f9a3
parent 5af530c24e bf5a69d3a0
commit 8f0537f9a3
1 changed files with 3 additions and 0 deletions
--- 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