Merge branch 'main' of github.com:mintlify/docs into quickstart_edits

Author: ricardonunez-io

.github/workflows/check-links.yml

@@ -0,0 +1,18 @@
+name: Check links
+
+on: pull_request
+
+jobs:
+  check-links:
+    name: Check links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "latest"
+      - name: Install Mintlify CLI
+        run: npm i -g mintlify
+      - name: Run broken link checker
+        run: mintlify broken-links

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+node_modules
+package-lock.json
+.idea/
+.vscode/

advanced/custom/css.mdx

@@ -4,7 +4,7 @@ description: 'Fully customize your documentation with custom CSS'
 ---
 
 <Check>
-  Custom CSS is available on the [growth plan](https://mintlify.com/pricing).
+  Custom CSS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
 </Check>
 
 Add any number of CSS files to your repository and the defined class names will be applied and available across all of your MDX files.

advanced/custom/js.mdx

@@ -4,14 +4,14 @@ description: 'Add JavaScript functionality globally'
 ---
 
 <Check>
-  Custom JS is available on the [growth plan](https://mintlify.com/pricing).
+  Custom JS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
 </Check>
 
 Custom JS allows you to add custom executable code globally. It is the equivalent of adding a `<script>` tag with JS code into every page.
 
-## Adding script.js
+## Adding Custom JavaScript
 
-For example, you can add the following `script.js` file to enable [Google Analytics](https://marketingplatform.google.com/about/analytics) across the entire documentation.
+Any `.js` file inside the content directory of your docs will be included in every documentation page. For example, you can add the following `ga.js` file to enable [Google Analytics](https://marketingplatform.google.com/about/analytics) across the entire documentation.
 
 ```js
 window.dataLayer = window.dataLayer || [];

advanced/rest-api/overview.mdx

@@ -14,7 +14,7 @@ functionality to the API overtime. Let us know what else you want to see in
 ## Authentication
 
 You can generate an API key through
-[the dashboard](https://dashboard.mintlify.com/settings/api). The API key is
+[the dashboard](https://dashboard.mintlify.com/settings/integrations). The API key is
 associated with the entire org and can be used across multiple deployments.
 
 <Frame>

advanced/rest-api/trigger-update.mdx

@@ -1,3 +1,4 @@
 ---
 openapi: "POST /project/update/{projectId}"
+hideApiMarker: true
 ---

advanced/rest-api/update-status.mdx

@@ -1,3 +1,4 @@
 ---
 openapi: "GET /project/update-status/{statusId}"
+hideApiMarker: true
 ---

advanced/subpath/cloudflare.mdx

@@ -5,7 +5,7 @@ description: "Host documentation at a /docs subpath using Cloudflare Workers"
 
 import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
 
-<SubpathGatingSnippet />
+<SubpathGatingSnippet platform="Cloudflare" />
 
 ## Create Cloudflare Worker
 
@@ -21,7 +21,7 @@ Cloudlfare worker.
 
 Once the worker is created, click `Configure worker`. Navigate to the worker
 `Settings > Triggers`. Click on `Add Custom Domain` to add your desired domain
-into the list - we reccommend you add both the version with and without `www.`
+into the list - we recommend you add both the version with and without `www.`
 prepended to the domain.
 
 <Frame>
@@ -77,16 +77,8 @@ async function handleRequest(request) {
     // if no action found, play the regular request
     return await fetch(request);
   }
-
-  return await fetch(request);
 }
 ```
 
 Click on `Deploy` and wait for the changes to propagate (it can take up to a few
 hours).
-
-## Reach out to Mintlify team
-
-Once completing the Cloudflare setup, the Mintlify team will setup the
-subdirectory settings in your deployment. Reach out over
-[email](mailto:[email protected]).

advanced/subpath/route53-cloudfront.mdx

@@ -5,7 +5,7 @@ description: "Host documentation at a /docs subdirectory using AWS services"
 
 import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
 
-<SubpathGatingSnippet />
+<SubpathGatingSnippet platform="AWS Services" />
 
 ## Create Cloudfront Distribution
 

advanced/subpath/vercel.mdx

@@ -0,0 +1,34 @@
+---
+title: "Vercel"
+description: "Host documentation at a /docs subpath using Vercel"
+---
+
+import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
+
+<SubpathGatingSnippet platform="Vercel" />
+
+## vercel.json Configuration
+
+To host your documentation at a custom subpath using Vercel, you need to add the
+following configuration to your `vercel.json` file.
+
+```json
+{
+  "rewrites": [
+    {
+      "source": "/docs",
+      "destination": "https://[subdomain].mintlify.dev/docs"
+    },
+    {
+      "source": "/docs/:match*",
+      "destination": "https://[subdomain].mintlify.dev/docs/:match*"
+    }
+  ]
+}
+```
+
+<Note>
+  For more information, you can also refer to Vercel's offical guide on
+  rewrites: [Project Configuration:
+  Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites)
+</Note>