You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: advanced/subpath/route53-cloudfront.mdx
+18-23Lines changed: 18 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,29 +12,23 @@ To host your documentation at a custom subpath such as `yoursite.com/docs` using
12
12
13
13
Your documentation files must be organized within your repository to match your chosen subpath structure. For example, if you want your documentation at `yoursite.com/docs`, you would create a `docs/` directory with all of your documentation files.
14
14
15
-
## Proxies with Vercel deployments
15
+
## High-level overview
16
16
17
-
If you use AWS CloudFront as a proxy with Vercel deployments, you must configure CloudFront to avoid interfering with Vercel's domain verification and SSL certificate provisioning.
18
-
19
-
Improper CloudFront configuration can prevent Vercel from provisioning Let's Encrypt SSL certificates and cause domain verification failures.
20
-
21
-
### Required path allowlist
22
-
23
-
CloudFront must allow traffic to these specific paths without caching or blocking:
17
+
Route traffic to these paths with a Cache Policy of **CachingDisabled**:
24
18
25
19
-`/.well-known/acme-challenge/*` - Required for Let's Encrypt certificate verification
26
-
-`/.well-known/vercel/*` - Required for Vercel domain verification
20
+
-`/.well-known/vercel/*` - Required for domain verification
21
+
-`/docs/*` - Required for subpath routing
22
+
-`/docs/` - Required for subpath routing
27
23
28
-
These paths should be configured to bypass CloudFront caching and pass through directly to your origin.
24
+
Route traffic to this path with a Cache Policy of **CachingEnabled**:
29
25
30
-
### Header forwarding requirements
26
+
-`/mintlify-assets/_next/static/*`
27
+
-`Default (*)` - Your websites landing page
31
28
32
-
You must create a custom origin request policy that forwards the `HOST` header and client IP information correctly. This is critical for Vercel's verification processes.
29
+
All Behaviors must have the an **origin request policy** of `AllViewerExceptHostHeader`.
33
30
34
-
1. Create a custom origin request policy named `VercelCloudFrontProxy`.
35
-
2. Include the `Origin` and `CloudFront-Viewer-Address` headers.
36
-
37
-
You must include the `CloudFront-Viewer-Address` header in your origin request policy or cache policy headers configuration to forward the header to your origin.
31
+
38
32
39
33
## Create CloudFront distribution
40
34
@@ -124,12 +118,7 @@ If `.well-known/*` is too generic, it can be narrowed down to 2 behaviors at a m
124
118
Create a behavior with a **Path pattern** of your chosen subpath, for example `/docs`, with **Origin and origin groups** pointing to the `.mintlify.dev` URL (in our case `acme.mintlify.dev`).
125
119
126
120
- Set "Cache policy" to **CachingOptimized**.
127
-
- In "Origin request policy", create an origin request policy named **VercelCloudFrontProxy**. That forwards the `Origin` and `CloudFront-Viewer-Address` headers.
128
-
129
-
<Frame>
130
-
131
-
</Frame>
132
-
121
+
- Set "Origin request policy" to **AllViewerExceptHostHeader**.
133
122
- Set Viewer Protocol Policy to **Redirect HTTP to HTTPS**
134
123
135
124
<Frame>
@@ -143,9 +132,15 @@ Create a behavior with a **Path pattern** of your chosen subpath followed by `/*
143
132
These settings should exactly match your base subpath behavior. With the exception of the **Path pattern**.
144
133
145
134
- Set "Cache policy" to **CachingOptimized**.
146
-
- Set "Origin request policy" to **VercelCloudFrontProxy**.
135
+
- Set "Origin request policy" to **AllViewerExceptHostHeader**.
147
136
- Set "Viewer protocol policy" to **Redirect HTTP to HTTPS**
148
137
138
+
### `/mintlify-assets/_next/static/*`
139
+
140
+
- Set "Cache policy" to **CachingOptimized**
141
+
- Set "Origin request policy" to **AllViewerExceptHostHeader**
142
+
- Set "Viewer protocol policy" to **Redirect HTTP to HTTPS**
143
+
149
144
### `Default (*)`
150
145
151
146
Lastly, we're going to edit the `Default (*)` behavior.
Copy file name to clipboardExpand all lines: changelog.mdx
+44Lines changed: 44 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,50 @@ rss: true
5
5
noindex: true
6
6
---
7
7
8
+
<Updatelabel="August 31 - September 13"tags={["New releases", "Improvements"]}rss={{ title: "Weekly Updates", description: "AI 404 suggestions, assistant web search with external sources, security enhancement, and reliability fixes" }}>
9
+
10
+
## Major releases
11
+
12
+
-**Major enhancement**: AI suggested pages on 404 pages, [when someone hits a dead link → AI agent reads the path → suggests semantically similar pages](https://x.com/mintlify/status/1966625627773059495)
13
+
-**Major release**: web search for assistant can now include external sources
14
+
_Note: Contact us to enable this feature for your site._
15
+
16
+
## Assistant and MCP
17
+
18
+
- Fixed a bug where the assistant would be incorrectly rate limited due to time window not sliding correctly
19
+
- Fixed a bug with assistant tool calling to properly handle empty `text` blocks
20
+
- Fixed a bug where MCP server name's concatenated with tool calls were sometimes exceeding the 60 character length MCP clients enforce
21
+
- Fixed a bug where the assistant menu would have a height several times larger than the viewport and scroll forever
22
+
- Fixed a bug where assistant spend values could display with greater than two decimal places in the dashboard
23
+
24
+
## Web editor and deployments
25
+
26
+
- Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes
27
+
- Fixed a bug where preview deployments wouldn't work for branches with `=` in the name
28
+
- Fixed a bug where long branch names would overflow modals on preview deployment creations
29
+
- Quality of life improvement where email query parameter will prefill the input on signup invitations
30
+
- Fixed a bug where copying a page from the context menu was not working on safari
31
+
32
+
## API playground and navigation
33
+
34
+
- Multiple API playground response codes now display in a controlled styled select menu instead of the system default select menu when focused
35
+
- You can now use the [`expanded` field on navigation groups in your `docs.json` to make them be default open](https://mintlify.com/docs/navigation#default-expanded-state)
36
+
37
+
## SEO and UI
38
+
39
+
- Fixed a bug where favicons were not showing up in search engines by serving them from the same URL as the documentation site itself for each respective site
40
+
- Fixed a bug where youtube embeds would flash in and out on load
41
+
- Fixed a bug where expanding the feedback menu to include written responses would cause layout shift with the table of contents
42
+
- Fixed a bug where text would leak above the topbar on the maple theme when a dismissed the notification banner
43
+
- Enhanced the Maple and Willow themes by adding login/logout buttons to the sidebar for easier access
44
+
45
+
## Analytics and exports
46
+
47
+
- Fixed reliability issues with assistant analytics view and exports
48
+
- Assistant analytics exports are now executed in the background and sent via email for a more reliable experience
49
+
50
+
</Update>
51
+
8
52
<Updatelabel="August 24 - August 30"tags={["Improvements"]}rss={{ title: "Weekly Updates", description: "Enhanced feedback collection, navigation improvements, and authentication bug fixes" }}>
Copy file name to clipboardExpand all lines: editor/branches.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: "Working with branches"
3
3
description: "Use branches to make and review changes without affecting your live documentation"
4
4
---
5
5
6
-
Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content that is used to build your live documentation. All other branches are independent of your live docs unless you choose to merge them into your deployment branhc.
6
+
Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content that is used to build your live documentation. All other branches are independent of your live docs unless you choose to merge them into your deployment branch.
7
7
8
8
Branches let you create separate instances of your documentation to make changes, get reviews, and try new approaches before publishing. Your team can work on branches to update different parts of your documentation at the same time without affecting what users see on your live site until you publish any changes.
Copy file name to clipboardExpand all lines: navigation.mdx
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ Use groups to organize your sidebar navigation into sections. Groups can be nest
57
57
alt=""
58
58
/>
59
59
60
-
In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`and `tag` fields are optional.
60
+
In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, and `expanded` fields are optional.
61
61
62
62
```json
63
63
{
@@ -66,6 +66,7 @@ In the `navigation` object, `groups` is an array where each entry is an object t
66
66
{
67
67
"group": "Getting started",
68
68
"icon": "play",
69
+
"expanded": false,
69
70
"pages": [
70
71
"quickstart",
71
72
{
@@ -92,6 +93,18 @@ In the `navigation` object, `groups` is an array where each entry is an object t
92
93
}
93
94
```
94
95
96
+
### Default expanded state
97
+
98
+
Set `expanded: true` on a group to make it expanded by default in the navigation sidebar. This is useful for highlighting important sections or improving discoverability of key content.
99
+
100
+
```json
101
+
{
102
+
"group": "Getting started",
103
+
"expanded": true,
104
+
"pages": ["quickstart", "installation"]
105
+
}
106
+
```
107
+
95
108
## Tabs
96
109
97
110
Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections.
description: "Customize the title and description of your 404 error page"
4
+
icon: "file-warning"
5
+
---
6
+
7
+
You can control the title and description of the 404 error page that appears when users navigate to broken or missing links.
8
+
9
+
When customizing your 404 page, use the description to guide users to helpful resources or links in your documentation that can help them find what they're looking for.
10
+
11
+
## Configuration
12
+
13
+
Configure your 404 page in the `errors.404` section of your `docs.json` file:
14
+
15
+
```json
16
+
"errors": {
17
+
"404": {
18
+
"redirect": false,
19
+
"title": "I can't be found",
20
+
"description": "What ever **happened** to this _page_?"
21
+
}
22
+
}
23
+
```
24
+
25
+
## Parameters
26
+
27
+
<ResponseFieldname="redirect"type="boolean">
28
+
Whether to automatically redirect to the home page when a page is not found.
29
+
30
+
Set to `true` to redirect to the home page.
31
+
32
+
Set to `false` to show the custom 404 page.
33
+
</ResponseField>
34
+
35
+
<ResponseFieldname="title"type="string">
36
+
Custom title for the 404 error page. This replaces the default "Page not found" heading.
37
+
</ResponseField>
38
+
39
+
<ResponseFieldname="description"type="string">
40
+
Custom description for the 404 error page. Supports Markdown formatting.
<imgsrc="/images/gitlab/gitlab-project-access-token.png"alt="The Access tokens page in the GitLab dashboard. The settings to configure for Mintlify are highlighted."/>
35
37
</Frame>
36
38
37
39
</Step>
38
40
<Steptitle="Set up the connection">
39
-
Within the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings), add the project ID and access token from the previous steps alongside the other configurations. Click "Save Changes" when you're done.
41
+
In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings):
42
+
1. Enter your project ID and access token.
43
+
2. Complete any other required configurations.
44
+
3. Click **Save Changes**.
40
45
<Frame>
41
-
<imgsrc="/images/gitlab/gitlab-config.png" />
46
+
<imgsrc="/images/gitlab/gitlab-config.png"alt="The Git Settings page in the Mintlify dashboard. The GitLab configuration settings are highlighted."/>
<imgsrc="/images/gitlab/gitlab-project-webtoken.png"alt="The Webhook page in the GitLab dashboard. The settings to configure for Mintlify are highlighted."/>
0 commit comments