Merge branch 'main' of https://github.com/mohab-sameh/docs

Author: mohab-sameh

integrations/custom/css.mdx renamed to advanced/custom/css.mdx

@@ -28,7 +28,7 @@ footer {
 
 Mintlify has a set of common identifiers to help you tag important elements of the UI. Some, but not all are listed in the following:
 
-`#topbar-cta-button` `#navbar` `#sidebar` `#content-area` `table-of-contents`
+`#topbar-cta-button` `#navbar` `#sidebar` `#content-area` `#table-of-contents`
 
 <Tip>
   Use inspect element to find references to elements you're looking to

integrations/custom/js.mdx renamed to advanced/custom/js.mdx

@@ -1,5 +1,5 @@
 ---
-title: Overview
+title: Introduction
 ---
 
 <Check>

integrations/rest-api/overview.mdx renamed to advanced/rest-api/overview.mdx

@@ -3,11 +3,9 @@ title: "Cloudflare"
 description: "Host documentation at a /docs subpath using Cloudflare Workers"
 ---
 
-<Info>
-  **Prerequisite**: Your primary domain (company.com) is hosted on Cloudflare
-  and you are on the [Mintlify startup plan or
-  above](https://mintlify.com/pricing).
-</Info>
+import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
+
+<SubpathGatingSnippet />
 
 ## Create Cloudflare Worker
 

integrations/rest-api/trigger-update.mdx renamed to advanced/rest-api/trigger-update.mdx

@@ -1,11 +1,11 @@
 ---
-title: 'Route 53 and Cloudfront'
-description: 'Host documentation at a /docs subdirectory using AWS services'
+title: "Route 53 and Cloudfront"
+description: "Host documentation at a /docs subdirectory using AWS services"
 ---
 
-<Info>
-  **Prerequisite**: Your primary domain (company.com) is hosted on Route 53.
-</Info>
+import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
+
+<SubpathGatingSnippet />
 
 ## Create Cloudfront Distribution
 
@@ -15,7 +15,7 @@ Navigate to [Cloudfront](https://aws.amazon.com/cloudfront) inside the AWS conso
   ![Cloudfront Create Distribution](/images/cloudfront/create-distribution.png)
 </Frame>
 
-For the Origin domain, input `[SUBDOMAIN].mintlify.dev` where `[SUBDOMAIN]` is the project's unqiue subdomain. Click on `Use: [SUBDOMAIN].mintlify.dev`
+For the Origin domain, input `[SUBDOMAIN].mintlify.dev` where `[SUBDOMAIN]` is the project's unique subdomain. Click on `Use: [SUBDOMAIN].mintlify.dev`
 
 <Frame>![Cloudfront Origin name](/images/cloudfront/origin-name.png)</Frame>
 

integrations/rest-api/update-status.mdx renamed to advanced/rest-api/update-status.mdx

@@ -12,6 +12,7 @@ Before your users can access personalized content, they must be authenticated. M
 
 <Tabs>
   <Tab title="Shared Session">
+
     - You have a dashboard or other user portal hosted at your domain.
     - Your users' session credentials are stored as cookies.
     - You can create a new API endpoint at the same origin or a subdomain of your dashboard.
@@ -22,6 +23,7 @@ Before your users can access personalized content, they must be authenticated. M
       - If your dashboard is at `*.foo.com`, your **docs** must be hosted at `foo.com` or `*.foo.com`
   </Tab>
   <Tab title="JWT">
+  
     - You have some existing login flow.
     - You can add a final step in this login flow that creates a JWT and redirects to the docs.
   </Tab>

integrations/subpath/cloudflare.mdx renamed to advanced/subpath/cloudflare.mdx

@@ -16,7 +16,7 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
     - Authenticate the user
     - Create a JWT containing the authenticated user's info in the [UserInfo](./sending-data) format
     - Sign the JWT with the secret
-    - Create a redirect URL back to your docs, including the JWT as a query parameter with the name `user_auth`
+    - Create a redirect URL back to your docs, including the JWT as the hash
   </Step>
   <Step title="Configure your User Auth settings">
     Return to your [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/integrations) and add the login URL to your User Auth settings.
@@ -27,6 +27,6 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
 
 I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs to be completely separate from my dashboard (or I don’t have a dashboard at all).
 
-To set up authentication with Mintlify, I go to my Mintlify dashboard and generate a JWT secret. I create a web URL `https://foo.com/docs-login` that initiates a login flow for my users. At the end of this login flow, once I have verified the identity of the user, I create a JWT containing the user’s custom data according to Mintlify’s specification. I sign this JWT with my Mintlify secret, create a redirect URL of the form `https://docs.foo.com?user_auth={SIGNED_JWT}`, and redirect the user.
+To set up authentication with Mintlify, I go to my Mintlify dashboard and generate a JWT secret. I create a web URL `https://foo.com/docs-login` that initiates a login flow for my users. At the end of this login flow, once I have verified the identity of the user, I create a JWT containing the user’s custom data according to Mintlify’s specification. I sign this JWT with my Mintlify secret, create a redirect URL of the form `https://docs.foo.com#{SIGNED_JWT}`, and redirect the user.
 
 I then go to the Mintlify dashboard settings and enter `https://foo.com/docs-login` for the Login URL field.

integrations/subpath/route53-cloudfront.mdx renamed to advanced/subpath/route53-cloudfront.mdx

@@ -1,5 +1,5 @@
 ---
-title: 'Overview'
+title: 'Introduction'
 description: 'Give your users a personalized docs experience'
 ---
 
@@ -13,7 +13,7 @@ User Auth allows you to configure a method for identifying and authenticating yo
 
 1. **Customize MDX content** with a user's information, such as their name, plan, or title.
 2. **Prefill API keys** in the API Playground for streamlined use.
-3. <b className="text-primary">(Coming soon!)</b> **Selectively show pages** in the navigation based on a user's groups.
+3. **Selectively show pages** in the navigation based on a user's groups.
 
 ## What *isn't* User Auth
 
@@ -22,29 +22,37 @@ At this time, User Auth cannot provide any of the following:
 1. **Private docs content.** While you can hide pages from unauthenticated users, those pages are still accessible by anyone who can guess the URL. If your documentation contains sensitive information, User Auth is not enough to hide it.
 2. **A Mintlify-backed user database.** Mintlify does not store *any* information about your users. Rather, it relies on your existing infrastructure to serve as the source-of-truth for user data.
 
-<Note>If you are interested in private docs content, [contact our team]([email protected]) to explore solutions.</Note>
+<Note>If you are interested in private docs content, [contact our team](mailto:[email protected]) to explore solutions.</Note>
 
 ## How to Use
 
 ### Customizing MDX Content
 
-When writing content, you can use the `userContext` variable to access the information you have sent to your docs. Here's a real world example:
+When writing content, you can use the `userContext` variable to access the information you have sent to your docs. Here's a simple example:
+
+Hello, {userContext.name ?? 'reader'}!
+
+```jsx
+Hello, {userContext.name ?? 'reader'}!
+```
+
+This feature becomes even more powerful when paired with custom data about the user. Here's a real world example that allows us to give specific instructions on how to access the User Auth feature based on the customer's existing plan:
 
 User Auth is an enterprise feature. {
   userContext.org === undefined
     ? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
     : userContext.org.plan !== 'enterprise'
-      ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To upgrade, navigate to the <a href="https://dashboard.mintlify.com/settings/billing">billing page</a> in the Mintlify dashboard.</>
-      : <>As an enterprise organization, you can enable this feature right now from your <a href="https://dashboard.mintlify.com/settings/integrations">Mintlify dashboard settings</a></>
+      ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:sales@mintlify.com">contact our sales team</a>.</>
+      : <>To request this feature for your enterprise org, <a href="mailto:sales@mintlify.com">contact our team</a>.</>
 }
 
 ```jsx
 User Auth is an enterprise feature. {
   userContext.org === undefined
     ? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
     : userContext.org.plan !== 'enterprise'
-      ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To upgrade, navigate to the <a href="https://dashboard.mintlify.com/settings/billing">billing page</a> in the Mintlify dashboard.</>
-      : <>As an enterprise organization, you can enable this feature right now from your <a href="https://dashboard.mintlify.com/settings/integrations">Mintlify dashboard settings</a></>
+      ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:sales@mintlify.com">contact our sales team</a>.</>
+      : <>To request this feature for your enterprise org, <a href="mailto:sales@mintlify.com">contact our team</a>.</>
 }
 ```
 
@@ -55,7 +63,6 @@ User Auth is an enterprise feature. {
 ### Prefilling API Keys
 
 If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground.
-{/* 
 ### Showing/Hiding Pages
 
 By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata.