Merge pull request #781 from supertokens/docs/add-dashboard-admonition

docs: added admonition clarifying dashboard url
supertokens · Mar 18, 2024 · e3d8bfa · e3d8bfa
2 parents c6ba133 + d213022
commit e3d8bfa
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 0 deletions.
diff --git a/v2/emailpassword/custom-ui/init/user-management-dashboard/setup.mdx b/v2/emailpassword/custom-ui/init/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/emailpassword/pre-built-ui/setup/user-management-dashboard/setup.mdx b/v2/emailpassword/pre-built-ui/setup/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/passwordless/custom-ui/init/user-management-dashboard/setup.mdx b/v2/passwordless/custom-ui/init/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/passwordless/pre-built-ui/setup/user-management-dashboard/setup.mdx b/v2/passwordless/pre-built-ui/setup/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdparty/custom-ui/init/user-management-dashboard/setup.mdx b/v2/thirdparty/custom-ui/init/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdparty/pre-built-ui/setup/user-management-dashboard/setup.mdx b/v2/thirdparty/pre-built-ui/setup/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdpartyemailpassword/custom-ui/init/user-management-dashboard/setup.mdx b/v2/thirdpartyemailpassword/custom-ui/init/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdpartyemailpassword/pre-built-ui/setup/user-management-dashboard/setup.mdx b/v2/thirdpartyemailpassword/pre-built-ui/setup/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdpartypasswordless/custom-ui/init/user-management-dashboard/setup.mdx b/v2/thirdpartypasswordless/custom-ui/init/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/thirdpartypasswordless/pre-built-ui/setup/user-management-dashboard/setup.mdx b/v2/thirdpartypasswordless/pre-built-ui/setup/user-management-dashboard/setup.mdx
@@ -116,6 +116,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials

diff --git a/v2/userdashboard/about.mdx b/v2/userdashboard/about.mdx
@@ -122,6 +122,10 @@ The user management dashboard is served by the backend SDK, you have to use your
 
 Navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard.
 
+:::note
+If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at `^{form_apiDomain}/api/auth/dashboard`. For frameworks other than Next.js, it can be accessed at `^{form_apiDomain}/auth/dashboard`. Should you have customized the `apiBasePath` configuration property, simply navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard` to access the dashboard.
+:::
+
 <img src="/img/dashboard/login.png" alt="Dashboard login screen UI" />
 
 ## Creating dashboard credentials