Update a lot of nits

handotdev · handotdev · commit 1e3e79d6226f · 2025-02-17T01:21:37.000-08:00
diff --git a/api-playground/openapi/advanced-features.mdx b/api-playground/openapi/advanced-features.mdx
@@ -13,9 +13,9 @@ For complex datatypes, OpenAPI provides the `oneOf`, `anyOf`, and `allOf` keywor
 - `anyOf` functions like an "or" operator
 - `allOf` functions like an "and" operator
 
-<Warning>Mintlify treats the `oneOf` and `anyOf` keywords the same. We have found that, when people use `oneOf`, they often *mean* `anyOf` - and there is often no meaningful difference to the user.</Warning>
+<Warning>The `oneOf` and `anyOf` keywords are treated the same. We have found that, when people use `oneOf`, they often *mean* `anyOf` - and there is often no meaningful difference to the user.</Warning>
 
-<Info>Mintlify currently does not support the `not` keyword.</Info>
+<Info>The `not` keyword is not currently supported.</Info>
 
 ### Combining schemas with `allOf`
 
diff --git a/api-playground/openapi/writing-openapi.mdx b/api-playground/openapi/writing-openapi.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Writing OpenAPI"
-description: "Use OpenAPI features to enhance your Mintlify docs"
+description: "Use OpenAPI features to enhance your documentation"
 ---
 
 ## Describing your API
diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx
@@ -10,6 +10,5 @@ The API playground is an interactive environment to make requests and preview an
 
 <Info>
   Autogenerating API pages with OpenAPI will automatically generate API
-  playground. Read more about using OpenAPI with Mintlify
-  [here](/api-playground/openapi).
+  playground. Read more about using OpenAPI [here](/api-playground/openapi).
 </Info>
diff --git a/development.mdx b/development.mdx
@@ -9,7 +9,7 @@ description: 'Preview changes locally to update your docs'
 
 </Info>
 
-**Step 1**: Install Mintlify:
+**Step 1**: Install the Mintlify CLI:
 
 <CodeGroup>
 
@@ -33,7 +33,7 @@ description: 'Preview changes locally to update your docs'
 mintlify dev
 ```
 
-Alternatively, if you do not want to install Mintlify globally you can use a run script available:
+Alternatively, if you do not want to install the CLI globally you can use a run script available:
 
 <CodeGroup>
   ```bash npm
@@ -58,19 +58,19 @@ A local preview of your documentation will be available at `http://localhost:300
 
 ### Custom Ports
 
-By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
+By default, Mintlify uses port 3000. You can customize the port using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
 
 ```bash
 mintlify dev --port 3333
 ```
 
-If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
+If you attempt to run on a port that's already in use, it will use the next available port:
 
 ```md
 Port 3000 is already in use. Trying 3001 instead.
 ```
 
-## Mintlify Versions
+## Versions
 
 Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
 
diff --git a/image-embeds.mdx b/image-embeds.mdx
@@ -11,7 +11,7 @@ icon: 'image'
 
 <Info>
   Mintlify supports files up to 5 MB. To use larger files, consider a storage
-  service like Cloudinary and embed in your Mintlify documentation.
+  service like Cloudinary and embed in your documentation using the URL.
 </Info>
 
 ## Image
diff --git a/migration.mdx b/migration.mdx
@@ -4,7 +4,7 @@ description: 'How to migrate documentation from your existing provider'
 icon: 'arrow-up-from-bracket'
 ---
 
-You can use our [public packages](https://www.npmjs.com/package/@mintlify/scraping) to scrape documentation frameworks to Mintlify. 
+You can use our [public packages](https://www.npmjs.com/package/@mintlify/scraping) to convert your existing documentation to Mintlify. 
 
 We currently support migration for:
 <CardGroup cols={2}>
diff --git a/settings/authentication-personalization/authentication-setup/jwt.mdx b/settings/authentication-personalization/authentication-setup/jwt.mdx
@@ -13,7 +13,7 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
 
 <Steps>
   <Step title="Generate a private key">
-    Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
+    Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
   </Step>
   <Step title="Create a login flow">
     Create a login flow that does the following:
@@ -23,7 +23,7 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
     - Create a redirect URL back to the `/login/jwt-callback` path of your docs, including the JWT as the hash
   </Step>
   <Step title="Configure your Authentication settings">
-    Return to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the login URL to your Authentication settings.
+    Return to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the login URL to your Authentication settings.
   </Step>
 </Steps>
 
@@ -39,7 +39,7 @@ I create a JWT containing the user’s custom data according to Mintlify’s spe
 I use a JWT library to sign this JWT with my Mintlify secret, create a redirect URL of the
 form `https://docs.foo.com/login/jwt-callback#{SIGNED_JWT}`, and redirect the user.
 
-I then go to the Mintlify dashboard settings and enter `https://foo.com/docs-login` for the
+I then go to the dashboard settings and enter `https://foo.com/docs-login` for the
 Login URL field.
 
 Here's what the code might look like:
diff --git a/settings/authentication-personalization/authentication-setup/mintlify.mdx b/settings/authentication-personalization/authentication-setup/mintlify.mdx
@@ -24,11 +24,11 @@ I want to set up authentication for my docs hosted at `docs.foo.com`. I want my
 to be internal, and the people that will be viewing my docs are the same people that
 contribute to my docs.
 
-To set up authentication with Mintlify, I can go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
+To set up authentication with Mintlify, I can go to my [dashboard settings](https://dashboard.mintlify.com/products/authentication)
 and enable Authentication with the Mintlify Auth Handshake.
 
 I can then ensure that anyone that should be able to read the docs has been added as a user in
-my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
+my [dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
 
 ## Implementation
 
diff --git a/settings/authentication-personalization/authentication-setup/oauth.mdx b/settings/authentication-personalization/authentication-setup/oauth.mdx
@@ -39,7 +39,7 @@ I have an existing OAuth server that supports the Authorization Code flow. I wan
 
 To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify’s specification.
 
-I then go to the Mintlify dashboard settings, navigate to the Authentication settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
+I then go to the dashboard settings, navigate to the Authentication settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
 - **Authorization URL**: `https://auth.foo.com/authorization`
 - **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
 - **Scopes**: `['docs-user-info']`
diff --git a/settings/authentication-personalization/personalization-setup/jwt.mdx b/settings/authentication-personalization/personalization-setup/jwt.mdx
@@ -14,7 +14,7 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
 
 <Steps>
   <Step title="Generate a private key">
-    Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
+    Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and generate a private key. Store this key somewhere secure where it can be accessed by your backend.
   </Step>
   <Step title="Create a login flow">
     Create a login flow that does the following:
@@ -24,7 +24,7 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
     - Create a redirect URL back to your docs, including the JWT as the hash
   </Step>
   <Step title="Configure your Personalization settings">
-    Return to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the login URL to your Personalization settings.
+    Return to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the login URL to your Personalization settings.
   </Step>
 </Steps>
 
@@ -40,7 +40,7 @@ I create a JWT containing the user’s custom data according to Mintlify’s spe
 I use a JWT library to 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
+I then go to the dashboard settings and enter `https://foo.com/docs-login` for the
 Login URL field.
 
 Here's what the code might look like:
diff --git a/settings/authentication-personalization/personalization-setup/oauth.mdx b/settings/authentication-personalization/personalization-setup/oauth.mdx
@@ -16,7 +16,7 @@ If you have an existing OAuth server that supports the PKCE flow, you can integr
     Create an API endpoint that can be accessed with an OAuth access token, and responds with a JSON payload following the [User](../sending-data) format. Take note of the scope or scopes required to access this endpoint.
   </Step>
   <Step title="Configure your Personalization settings">
-    Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication), select the OAuth option, and fill out the required fields:
+    Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication), select the OAuth option, and fill out the required fields:
 
     - **Authorization URL**: The base URL for the authorization request, to which we will add the appropriate query parameters.
     - **Client ID**: An ID for the OAuth 2.0 client to be used.
@@ -25,7 +25,7 @@ If you have an existing OAuth server that supports the PKCE flow, you can integr
     - **Info API URL**: The endpoint that will be hit to retrieve user info.
   </Step>
   <Step title="Configure your OAuth client">
-    Copy the Redirect URL listed in the [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and add it as an authorized redirect URL for your OAuth server.
+    Copy the Redirect URL listed in the [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add it as an authorized redirect URL for your OAuth server.
   </Step>
 </Steps>
 
@@ -35,7 +35,7 @@ I have an existing OAuth server that supports the PKCE flow. I want to set up au
 
 To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify’s specification.
 
-I then go to the Mintlify dashboard settings, navigate to the Personalization settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
+I then go to the dashboard settings, navigate to the Personalization settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
 - **Authorization URL**: `https://auth.foo.com/authorization`
 - **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
 - **Scopes**: `['docs-user-info']`
diff --git a/settings/authentication-personalization/personalization-setup/shared-session.mdx b/settings/authentication-personalization/personalization-setup/shared-session.mdx
@@ -23,7 +23,7 @@ This method utilizes the session authentication info already stored in your user
       </Warning>
   </Step>
   <Step title="Configure your Personalization settings">
-    Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the API URL and your Login URL to your Personalization settings.
+    Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the API URL and your Login URL to your Personalization settings.
   </Step>
 </Steps>
 
@@ -35,20 +35,20 @@ I have a dashboard at `dash.foo.com`, which uses cookie-based session authentica
 
 To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://docs.foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true` **for this route only**.
 
-I then go to the Mintlify dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
+I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
 
 ### Dashboard at subdomain, docs at root
 
 I have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. My dashboard API routes are hosted at `dash.foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`.
 
 To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true` **for this route only**.
 
-I then go to the Mintlify dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
+I then go to the dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field.
 
 ### Dashboard at root, docs at root
 
 I have a dashboard at `foo.com/dashboard`, which uses cookie-based session authentication. My dashboard API routes are hosted at `foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`.
 
 To set up authentication with Mintlify, I create another dashboard endpoint `foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification.
 
-I then go to the Mintlify dashboard settings and enter `https://foo.com/api/docs/user-info` for the API URL field.
+I then go to the dashboard settings and enter `https://foo.com/api/docs/user-info` for the API URL field.
diff --git a/snippets/config-upgrade.mdx b/snippets/config-upgrade.mdx
@@ -1,5 +1,5 @@
 <Note>
-  If you're currently using the legacy `mint.json` configuration file, please update the Mintlify CLI:
+  If you're currently using the legacy `mint.json` configuration file, please update the CLI:
 
 ```sh
 npm i -g mintlify@latest
diff --git a/snippets/custom-subpath-gating.mdx b/snippets/custom-subpath-gating.mdx
@@ -1,4 +1,4 @@
 <Info>
   **Prerequisite**: Your primary domain (company.com) is hosted on {platform}
-  and you are on the [Mintlify Pro plan or above](https://mintlify.com/pricing).
+  and you are on the [Pro plan or above](https://mintlify.com/pricing).
 </Info>
