From ad49dedec3f5247fd5ad9597e4a748cac35f3997 Mon Sep 17 00:00:00 2001
From: Jason Robinson <mail@jasonrobinson.me>
Date: Fri, 27 Nov 2020 15:04:40 +0200
Subject: [PATCH] Document hosting_signup config option in source

---
 src/components/structures/UserMenu.tsx | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/components/structures/UserMenu.tsx b/src/components/structures/UserMenu.tsx
index b621fac74a..ef4d214709 100644
--- a/src/components/structures/UserMenu.tsx
+++ b/src/components/structures/UserMenu.tsx
@@ -296,6 +296,22 @@ export default class UserMenu extends React.Component<IProps, IState> {
             )
         } else if (signupLink || hostingSignupOptions) {
             let hostingSignupIFrame;
+            /*
+                Config schema:
+
+                ```
+                "hosting_signup": {
+                    // URL to load iframe from.
+                    "url": "https://prodiver.tld/setup",
+                    // Accepted Matrix user server names to show iframe action for.
+                    // Subdomains will also match.
+                    "domains": [
+                        "matrix.org",
+                        "domain.tld"
+                    ]
+                }
+                ```
+            */
             if (hostingSignupOptions && hostingSignupOptions.url) {
                 // If hosting_signup_domains is set to a non-empty array, only show
                 // dialog if the user is on the domain or a subdomain.