Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions ai-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,24 @@
keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"]
---

import Openapi from '/api-components/openapi.mdx';

When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your documentation.

## What makes your documentation AI-native
<Openapi />

<Card title="jay and ben" type="info">
</Card>

### Reading
<Accordion title="tommy">
is cool
</Accordion>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Draft test content on AI-native page

High Severity

The AI-native page now embeds an Openapi snippet plus placeholder Card and Accordion content (jay and ben, tommy) that is unrelated to the page. This draft material would publish on a high-traffic docs page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here.


## What makes your documentation AI-native

In addition to reading individual pages, users can chat with the [assistant](/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message-v2) to extend where users can access your documentation.
<Accordion title="Reading">
In addition to reading individual pages, i in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message-v2) to extend where users can access your documentation.

Check warning on line 24 in ai-native.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai-native.mdx#L24

Avoid first-person pronouns such as ' i '.
</Accordion>

### Writing

Expand Down
12 changes: 0 additions & 12 deletions cli/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,16 +161,4 @@ You can also format MDX files with [`mint format`](/cli/commands#mint-format).

**Solution**: Ask your IT administrator to add `releases.mintlify.com` to your network allowlist.
</Accordion>
<Accordion title="CLI connects to localhost instead of production when using npx">
In versions before `4.0.1125`, running `npx mint dev` or other commands from a docs
repository could cause the CLI to incorrectly detect itself as a local development
build. This made the CLI point to `localhost` URLs instead of the Mintlify production
API, resulting in connection errors or unexpected behavior.

**Solution**: Update to the latest CLI version:

```bash
npm i -g mint@latest
```
</Accordion>
</AccordionGroup>
2 changes: 0 additions & 2 deletions components/accordions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import IconsOptional from "/snippets/icons-optional.mdx";

Use accordions to organize information and progressively disclose content. Users can expand and collapse each section.

When you open an accordion, the URL hash updates, which lets you share direct links to specific accordion sections.

## Single accordion

<Accordion title="I am an Accordion.">
Expand Down
6 changes: 3 additions & 3 deletions contact-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Contact Mintlify support for help with your documentation site, in

## Ask our docs

Use the keyboard shortcut <kbd>Cmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation.
Use the keyboard shortcut <kbd>Cmmmd</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux). This starts a chat with our AI assistant trained on our documentation.

## Watch video tutorials

Expand All @@ -16,7 +16,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut
Send us a message from your [dashboard](https://app.mintlify.com/). Click the <Icon icon="headphones" /> support button in the top bar to open a support chat.

<Frame>
<img src="/images/support-button.png" alt="Support button in the top right of the dashboard." />
![Support button in the top right of the dashboard.](/images/support-button.png)
</Frame>

<Info>
Expand All @@ -25,4 +25,4 @@ Send us a message from your [dashboard](https://app.mintlify.com/). Click the <I

## Contact via email

If you can't access your dashboard, email us at <a href="mailto:[email protected]">[email protected]</a>. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-deployment`.
If you can't access your dashboard, email us at <a href="mailto:[email protected]">[[email protected]](mailto:[email protected])</a>. Include the URL of your [dashboard](https://app.mintlify.com/) with your organization and deployment in your email so we can help you faster. For example, `app.mintlify.com/your-org/your-deployment`.
2 changes: 1 addition & 1 deletion create/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Headings

Headings organize your content and create navigation anchors. They appear in the table of contents and help users scan your documentation.
fawefaewt and create navigation anchors. They appear in the table of contents and help users scan your documentation.

Check warning on line 9 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L9

Did you really mean 'fawefaewt'?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings intro replaced with garbage

Medium Severity

The headings introduction now starts with fawefaewt instead of explaining that headings organize content, so the Format text page opens with unreadable copy.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here.


### Create headings

Expand Down Expand Up @@ -41,7 +41,7 @@
| Heading text | Generated ID |
| :--- | :--- |
| `Getting started` | `getting-started` |
| `Config.json options` | `config-json-options` |

Check warning on line 44 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L44

Use 'config' instead of 'Config'.
| `What's new` | `what’s-new` |
| `Rate limits (per minute)` | `rate-limits-per-minute` |
| `Read/write access` | `read/write-access` |
Expand Down
3 changes: 3 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,9 @@
]
}
]
},
{
"tab": "Example"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Empty Example tab added to navigation

Medium Severity

docs.json adds a navigation tab named Example with no pages, groups, or href. The tab would appear in the site nav with nothing to show.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here.

}
],
"language": "en"
Expand Down
10 changes: 6 additions & 4 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
boost: 3
---

import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx";
# header

Check warning on line 8 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L8

'header' should use sentence-style capitalization.

body text

After you complete this guide, you'll have a live documentation site ready to customize and update.
![Favicon](/favicon.ico "Favicon")

import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx";

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder content added to Quickstart

High Severity

The Quickstart now opens with # header, body text, and a favicon image, and the SetupAgentPrompt import sits below that content. This draft material would publish on the main onboarding page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 6ff1a79. Configure here.


<Visibility for="humans">
<Tip>
Expand Down Expand Up @@ -61,8 +65,6 @@
## Deploy your documentation site

<Visibility for="humans">
Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your site and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments.

In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select **Skip, start from a blank template**.

After onboarding, your documentation site deploys and is accessible at your `.mintlifysite.com` URL.
Expand All @@ -75,7 +77,7 @@
</Visibility>

<Visibility for="agents">
Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlifysite.com` URL loads.

Check warning on line 80 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L80

Use semicolons judiciously.
</Visibility>

## View your deployed site
Expand Down