Merge branch 'main' into sam/change-image-in-card

Author: hahnbeelee

.github/workflows/index-sitemap.yml

@@ -0,0 +1,24 @@
+name: Index docs
+
+on:
+  schedule:
+    - cron: "0 */3 * * *"  
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install CLI
+        run: npm install -g @team-plain/cli@latest
+        
+      - name: Index Docs
+        run: plain index-sitemap https://mintlify.com/docs/sitemap.xml
+        env:
+          PLAIN_API_KEY: ${{ secrets.PLAIN_API_KEY }}

.gitignore

@@ -1,3 +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 as an add-on to the [pro 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,7 +4,7 @@ description: 'Add JavaScript functionality globally'
 ---
 
 <Check>
-  Custom JS is available as an add-on to the [pro 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.

advanced/rest-api/chat/create-topic.mdx

@@ -0,0 +1,3 @@
+---
+openapi: POST /chat/topic
+---

advanced/rest-api/chat/generate-message.mdx

@@ -0,0 +1,3 @@
+---
+openapi: POST /chat/message
+---

advanced/rest-api/overview.mdx

@@ -1,12 +1,10 @@
 ---
-title: Introduction
+title: Overview
 ---
 
-<Check>
-  The Mintlify REST API is only available on the startup plan and above.
-</Check>
+## Trigger Updates
 
-Leverage the external API to programmatically trigger an update when desired.
+Leverage the REST API to programmatically trigger an update when desired.
 The primary use-case will be to trigger updates. We will be adding more and more
 functionality to the API overtime. Let us know what else you want to see in
 [our community](https://mintlify.com/community)!
@@ -20,3 +18,28 @@ associated with the entire org and can be used across multiple deployments.
 <Frame>
   <img src="/images/external-api-key.png" />
 </Frame>
+
+## Chat API
+
+The Chat API allows you to embed an AI chat experience grounded in your docs and continually kept up to date into any application of your choosing.
+Responses include citations so you can point your users to the right places they need to get help.
+
+## Getting Started
+
+To get started, you'll need to generate a Chat API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):
+
+<Frame>
+  <img
+    alt="Create a Chat API key"
+    src="/images/generate-discovery-api-key.png"
+  />
+</Frame>
+
+<Note>
+  The Chat API token is a public token that can be referenced in your
+  frontend code whereas the API key is a server-side token that should be kept
+  secret.
+</Note>
+
+Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
+the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).

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

@@ -3,20 +3,20 @@ title: "Cloudflare"
 description: "Host documentation at a /docs subpath using Cloudflare Workers"
 ---
 
-import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
-
-<SubpathGatingSnippet platform="Cloudflare" />
-
 ## Create Cloudflare Worker
 
 Navigate to the `Workers & Pages > Create application > Create worker`. You
-should be able to presented with the following screen where you can create a new
+should be presented with the following screen where you can create a new
 Cloudlfare worker.
 
 <Frame>
   <img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
 </Frame>
 
+<Warning>
+    Keep in mind: If your DNS provider is Cloudflare you should not use proxying for the CNAME record
+</Warning>
+
 ### Add custom domain
 
 Once the worker is created, click `Configure worker`. Navigate to the worker
@@ -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]).