Skip to content

Commit a703529

Browse files
committed
Merge branch 'main' into dean/cloudflare-warning
2 parents 1b1b9c1 + 91d7bee commit a703529

File tree

127 files changed

+4600
-1759
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+4600
-1759
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Index docs
2+
3+
on:
4+
schedule:
5+
- cron: "0 */3 * * *"
6+
7+
jobs:
8+
lint:
9+
name: Lint
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- uses: actions/setup-node@v3
15+
with:
16+
node-version: '18'
17+
18+
- name: Install CLI
19+
run: npm install -g @team-plain/cli@latest
20+
21+
- name: Index Docs
22+
run: plain index-sitemap https://mintlify.com/docs/sitemap.xml
23+
env:
24+
PLAIN_API_KEY: ${{ secrets.PLAIN_API_KEY }}

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
.DS_Store
22
node_modules
33
package-lock.json
4+
.idea/
5+
.vscode/

advanced/custom/css.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Fully customize your documentation with custom CSS'
44
---
55

66
<Check>
7-
Custom CSS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
7+
Custom CSS is available as an add-on to the [Pro plan](https://mintlify.com/pricing).
88
</Check>
99

1010
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Add JavaScript functionality globally'
44
---
55

66
<Check>
7-
Custom JS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
7+
Custom JS is available as an add-on to the [Pro plan](https://mintlify.com/pricing).
88
</Check>
99

1010
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.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/topic
3+
---
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/message
3+
---

advanced/rest-api/overview.mdx

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
title: Introduction
2+
title: Overview
33
---
44

5-
<Check>
6-
The Mintlify REST API is only available on the startup plan and above.
7-
</Check>
5+
## Trigger Updates
86

9-
Leverage the external API to programmatically trigger an update when desired.
7+
Leverage the REST API to programmatically trigger an update when desired.
108
The primary use-case will be to trigger updates. We will be adding more and more
119
functionality to the API overtime. Let us know what else you want to see in
1210
[our community](https://mintlify.com/community)!
@@ -20,3 +18,28 @@ associated with the entire org and can be used across multiple deployments.
2018
<Frame>
2119
<img src="/images/external-api-key.png" />
2220
</Frame>
21+
22+
## Chat API
23+
24+
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.
25+
Responses include citations so you can point your users to the right places they need to get help.
26+
27+
## Getting Started
28+
29+
To get started, you'll need to generate a Chat API key in the [dashboard](https://dashboard.mintlify.com/products/chat/widget):
30+
31+
<Frame>
32+
<img
33+
alt="Create a Chat API key"
34+
src="/images/generate-discovery-api-key.png"
35+
/>
36+
</Frame>
37+
38+
<Note>
39+
The Chat API token is a public token that can be referenced in your
40+
frontend code whereas the API key is a server-side token that should be kept
41+
secret.
42+
</Note>
43+
44+
Now that you have an API key, check out our [example](https://github.com/mintlify/discovery-api-example) for how to use
45+
the API for AI chat. You can also see a deployed version of this example at [chat.mintlify.com](https://chat.mintlify.com).
File renamed without changes.
File renamed without changes.

advanced/subpath/cloudflare.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: "Cloudflare"
33
description: "Host documentation at a /docs subpath using Cloudflare Workers"
44
---
55

6-
76
import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
87

98
<SubpathGatingSnippet platform="Cloudflare" />
@@ -82,8 +81,6 @@ async function handleRequest(request) {
8281
// if no action found, play the regular request
8382
return await fetch(request);
8483
}
85-
86-
return await fetch(request);
8784
}
8885
```
8986

0 commit comments

Comments
 (0)