Skip to content
Closed
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
2 changes: 2 additions & 0 deletions agent/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,5 @@ Integrate the agent into your existing automation tools to automatically update
Use the agent endpoints to [create jobs](/api/agent/v2/create-agent-job), [get job status](/api/agent/v2/get-agent-job), and [send messages](/api/agent/v2/send-message).

When creating jobs via the API, you can control whether pull requests open in draft mode using the `asDraft` parameter (defaults to `false`). Set `asDraft: true` to create draft pull requests, or keep the default to create non-draft pull requests ready for immediate review and merging in automated workflows.

/

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stray character on use cases page

Low Severity

A lone / was appended after the Automate with the API section. It will render as visible stray text at the bottom of the published page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 11c883c. Configure here.

18 changes: 13 additions & 5 deletions cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@ keywords: ["CLI", "mint", "local development", "preview"]

import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

import Openapi from '/api-playground/openapi.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.

Unused OpenAPI import on CLI page

Medium Severity

cli/index.mdx now imports Openapi from /api-playground/openapi.mdx but never uses it. That path does not exist in api-playground, so the unused import can break the CLI landing page build.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 11c883c. Configure here.


<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/installation/local-development-light.png"
className="block my-0 pointer-events-none dark:hidden"
alt="Decorative graphic representing the CLI."
src="/images/installation/local-development-light.png"
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/installation/local-development-dark.png"
className="my-0 pointer-events-none hidden dark:block"
alt="Decorative graphic representing the CLI."
src="/images/installation/local-development-dark.png"
/>

## About the CLI
Expand All @@ -28,21 +30,27 @@ The CLI runs on your machine and connects to your Mintlify deployment when you n
</Visibility>

### Preview locally

Run `mint dev` to preview your documentation at `localhost:3000`. As you write and update your content, changes appear in real time without deploying. Log in to enable search and the AI assistant in your local preview.

### Run quality checks

Run `mint broken-links` to find broken links, `mint a11y` to check accessibility, and `mint validate` to validate your documentation build before it reaches production.

### Check agent readiness

Run `mint score` to evaluate how well agents can navigate a documentation site. With no arguments, the command scores your configured subdomain. Pass a URL to score any other site. The command displays an overall readiness score and individual check results.

### Format MDX files

Run `mint format` to rewrite the MDX files in your project to Mintlify's canonical style. The command walks every subdirectory and reformats files in place.

### Query analytics

Run `mint analytics` to view documentation stats, search queries, feedback, and assistant conversations from the terminal. Output defaults to JSON when the CLI detects an AI or CI environment, so agents can pipe results into other tools.

### Manage configuration

Run `mint config` to set persistent defaults like your documentation subdomain.

<Tip>
Expand All @@ -56,4 +64,4 @@ Run `mint config` to set persistent defaults like your documentation subdomain.
- [Install the CLI](/cli/install): Get the CLI installed and ready to use.
- [Mintlify MDX extension](/cli/mdx-extension): Add autocomplete, inline error checking, and an in-editor preview.
- [Preview locally](/cli/preview): Run a local development server with search and assistant support.
- [Commands](/cli/commands): Complete reference for all commands and flags.
- [Commands](/cli/commands): Complete reference for all commands and flags.
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,8 @@
"group": "Export your site",
"pages": [
"deploy/export",
"optimize/pdf-exports"
"optimize/pdf-exports",
"untitled-page-2"

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 page added to navigation

Medium Severity

The Export your site group now includes untitled-page-2, which points at an empty file with no frontmatter or content. Readers will see a blank untitled page in that navigation section.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 11c883c. Configure here.

]
},
{
Expand Down
20 changes: 10 additions & 10 deletions optimize/pdf-exports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Full-site PDF exports include all pages regardless of group restrictions, so any
To let users download individual pages as PDFs, use the [contextual menu's](/ai/contextual-menu) `download-pdf` option.
</Tip>

## Export all content
# Export all content

1. Navigate to the [Exports](https://app.mintlify.com/settings/deployment/export-docs) page in your dashboard.
2. Click **Export all content**.
3. Optionally, customize the export options:
- **Page format**: Choose the page size of the PDF.
- **Scale percent**: Adjust the scale of the PDF.
- **Include footer**: Include a footer with the page number and total pages.
- **Language**: If your content is available in multiple languages, choose which language to export.
- **Page format**: Choose the page size of the PDF.
- **Scale percent**: Adjust the scale of the PDF.
- **Include footer**: Include a footer with the page number and total pages.
- **Language**: If your content is available in multiple languages, choose which language to export.
4. Click **Export**.
5. When the export completes, Mintlify sends you an email with a link to download the PDF file.

Expand All @@ -45,9 +45,9 @@ Full-site PDF exports include all pages regardless of group restrictions, so any
2. Click **New export**.
3. Select the pages you want to export.
4. Optionally, customize the export options:
- **Page format**: Choose the page size of the PDF.
- **Scale percent**: Adjust the scale of the PDF.
- **Include footer**: Include a footer with the page number and total pages.
- **Language**: If your content is available in multiple languages, choose which language to export.
- **Page format**: Choose the page size of the PDF.
- **Scale percent**: Adjust the scale of the PDF.
- **Include footer**: Include a footer with the page number and total pages.
- **Language**: If your content is available in multiple languages, choose which language to export.
5. Click **Export**.
6. When the export completes, Mintlify sends you an email with a link to download the PDF file.
6. When the export completes, Mintlify sends you an email with a link to download the PDF file.
26 changes: 9 additions & 17 deletions poc-onboarding.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "POC onboarding"

Check warning on line 2 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L2

Spell out 'POC', if it's unfamiliar to the audience.
description: "Set up and evaluate a Mintlify proof of concept, from connecting your repository to reviewing publishing, AI, and security workflows."
keywords: ["POC", "proof of concept", "trial", "evaluation", "enterprise onboarding", "pilot"]

Check warning on line 4 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L4

Spell out 'POC', if it's unfamiliar to the audience.
noindex: true
---

Expand All @@ -11,12 +11,12 @@
If you get stuck, contact your account executive (AE) or solutions engineer (SE), or email [support@mintlify.com](mailto:support@mintlify.com).
</Note>

## POC workflow

Check warning on line 14 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L14

Spell out 'POC', if it's unfamiliar to the audience.

Check warning on line 14 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L14

'POC workflow' should use sentence-style capitalization.

Complete these steps in order:

| Step | Outcome |
|---|---|
| --- | --- |
| 1. Connect your repository | Deploy a starter site. |
| 2. Invite your team | Give participants the access they need. |
| 3. Add sample content | Test representative and complex pages. |
Expand All @@ -32,8 +32,8 @@
### Identify participants

| Role | Responsibility | Time needed |
|---|---|---|
| --- | --- | --- |
| Documentation owner | Runs the POC and completes most steps. | A few hours total |

Check warning on line 36 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L36

Spell out 'POC', if it's unfamiliar to the audience.
| GitHub administrator | Approves the Mintlify GitHub App. | 15 minutes |
| Designer or brand owner | Provides logos, colors, and fonts. | 30 minutes |
| Identity or IT administrator | Configures DNS for a custom domain, if you test authentication. | 1 to 2 hours |
Expand All @@ -59,7 +59,7 @@
- **Engineering time saved:** Reduce the engineering hours spent writing, reviewing, and maintaining documentation.
- **Retention:** Increase adoption of a feature after launch.

Add two or three criteria that you can test during the POC. For example:

Check warning on line 62 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L62

Spell out 'POC', if it's unfamiliar to the audience.

- A writer without Git experience can publish a change without help.
- Your most complex API reference page renders correctly.
Expand All @@ -78,13 +78,11 @@
<Step title="Create your account">
Go to [mintlify.com/start](https://mintlify.com/start) and sign up with your work email address.
</Step>

<Step title="Choose a repository">
Connect GitHub during onboarding. Create a repository or select an empty one in your company organization. A private repository named `docs` is a common choice.

Do not select a repository that contains application code or unrelated files.
</Step>

<Step title="Install the GitHub App">
Ask your GitHub administrator to install the Mintlify GitHub App. Grant access to the documentation repository by selecting **Only select repositories**.

Expand All @@ -96,13 +94,12 @@
To continue while approval is pending, skip the Git provider during onboarding. Mintlify creates a private repository that you can later move from [Git settings](https://app.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository).
</Accordion>
</Step>

<Step title="Open your site">
After the starter content deploys, find your URL on the **Overview** page of the [dashboard](https://app.mintlify.com/). Open the `https://<your-subdomain>.mintlify.site` URL and confirm that it loads.
</Step>
</Steps>

Use the `.mintlify.site` URL during the POC unless you need to test authentication. Authentication requires a [custom domain](/customize/custom-domain) or `*.mintlify.app` subdomain, and does not work on a custom basepath such as `yourcompany.com/docs`.

Check warning on line 102 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L102

Spell out 'POC', if it's unfamiliar to the audience.

Check warning on line 102 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L102

Did you really mean 'basepath'?

## Step 2: Invite your team

Expand Down Expand Up @@ -134,7 +131,7 @@

<Tabs>
<Tab title="Use Mintlify migration services">
Ask your AE or SE whether migration is included in your POC. If it is, send:

Check warning on line 134 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L134

In general, use active voice instead of passive voice ('is included').

Check warning on line 134 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L134

Spell out 'POC', if it's unfamiliar to the audience.

- Your current documentation URL or export.
- Your list of sample pages.
Expand All @@ -143,7 +140,6 @@

See [Enterprise migrations](/migration-services/enterprise) for the full migration process.
</Tab>

<Tab title="Migrate it yourself">
Use one of these methods:

Expand All @@ -153,7 +149,6 @@

See [Migrate to Mintlify](/migration) for other platforms.
</Tab>

<Tab title="Connect an existing content source">
If your source content lives in Notion, Confluence, Jira, or a similar tool, connect it to the Mintlify agent. See [Integrations for the agent and automations](/automations/integrations).
</Tab>
Expand All @@ -176,23 +171,20 @@

<Steps>
<Step title="Create a branch">
Open the [web editor](https://app.mintlify.com/editor). Click the branch name in the editor toolbar, select **Create new branch**, enter a name, then click **Create branch**.
Open the [web editor](https://app.mintlify.com/editor). Click the branch name in the editor toolbar, select **Create new branch**, enter a name, then click **CreateClick the branch name in the editor toolbar, select Create new branch**, enter a name, then click **Create branch**.

A branch keeps the draft separate from your deployed site.
</Step>

<Step title="Edit a page">
Edit the page in the visual editor. Type `/` to insert a component or drag an image onto the page to upload it.

Press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (Windows) to switch between the rendered visual mode and the MDX source.
Press <kbd>Cmd</kbd> \+ <kbd>Shift</kbd> \+ <kbd>S</kbd> (macOS) or <kbd>Ctrl</kbd> \+ <kbd>Shift</kbd> \+ <kbd>S</kbd> (Windows) to switch between the rendered visual mode and thePress <kbd>Cmd</kbd> \+ <kbd>Shift</kbd> \+ <kbd>S</kbd> (macOS) or <kbd>Ctrl</kbd> \+ <kbd>Shift</kbd> \+ <kbd>S</kbd> (Windows) to switch between the rendered visual mode and the MDX source.
</Step>

<Step title="Share the preview">
Select **Create pull request**. Mintlify builds a [preview deployment](/editor/review#preview-deployments): a temporary URL where your changes render exactly as they look when published. Copy the URL and send it to a reviewer. Make any requested changes on the same branch. The preview rebuilds each time you save.
Select **Create pull request**. Mintlify builds a [preview deployment](/editor/review#preview-deployments): a temporary URL where your changes render exactly as they look when published. Copy the URL and send it to a reviewer. Make any requested changes on the same branch. The preview rebuilds each time you saveSelect **Create pull request**. Mintlify builds a [preview deployment](/editor/review#preview-deployments): a temporary URL where your changes render exactly as they look when published. Copy the URL and send it to a reviewer. Make any requested changes on the same branch. The preview rebuilds each time you save.

Check warning on line 184 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L184

Did you really mean 'saveSelect'?
</Step>

<Step title="Publish">
Merge the pull request to deploy the change to your live site. Publishing from your deployment branch deploys the change immediately without a pull request. See [Publish changes](/editor/publish).
Merge the pull request to deploy the change to your live site. Publishing from your deployment branch deploys the change immediately without a pull request. See [Publish changes](/editor/publish)Merge the pull request to deploy the change to your live site. Publishing from your deployment branch deploys the change immediately without a pull request. See [Publish changes](/editor/publish).

Confirm that the commit appears on the dashboard **Overview** page and that the approved change appears on your site.
</Step>
Expand Down Expand Up @@ -259,7 +251,7 @@
3. Record whether the answer is correct and cites the right page.
4. Use wrong or missing answers to identify pages to update or create.

Review unanswered and downvoted questions in [Assistant analytics](/analytics/assistant). If a relevant page is not cited, make its frontmatter `description` specific and unique.

Check warning on line 254 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L254

Did you really mean 'downvoted'?

### Test one additional AI workflow

Expand All @@ -283,15 +275,15 @@

## Step 7: Review results

Book one hour with your decision maker. Start with the goal and baseline you defined before the POC, then review:

Check warning on line 278 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L278

Spell out 'POC', if it's unfamiliar to the audience.

| Criterion | Evidence |
|---|---|
| --- | --- |
| A non-developer can publish | The step 4 result and time required. |
| Engineers keep review control | The pull request and its checks. |
| Complex content migrates correctly | Side-by-side sample pages. |
| The assistant answers accurately | Your scored questions and cited pages. |
| Content gaps are identifiable | Unanswered and downvoted questions in [Assistant analytics](/analytics/assistant). |

Check warning on line 286 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L286

Did you really mean 'downvoted'?
| Readers find useful content | [Traffic](/analytics/traffic), [search](/analytics/search), and [engagement](/analytics/user-engagements) data. |
| Automated updates are useful | The automation run history and proposed change. |

Expand All @@ -299,22 +291,22 @@

## Suggested timeline

Most POCs take two to three weeks:

Check warning on line 294 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L294

Did you really mean 'POCs'?

| Week | Focus |
|---|---|
| --- | --- |
| Week 1 | Connect the repository, invite your team, define success, and start the content migration. Start domain setup if you need authentication. |
| Week 2 | Review content, publish a change, apply branding, test the assistant, and evaluate one AI workflow. |
| Week 3 | Review the results with your decision maker. |

## Getting help

- Contact your AE or SE for time-sensitive POC questions.

Check warning on line 304 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L304

Spell out 'POC', if it's unfamiliar to the audience.
- Email [support@mintlify.com](mailto:support@mintlify.com) for other questions.
- See [Advanced support](/advanced-support) for post-POC support options.

Check warning on line 306 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L306

Spell out 'POC', if it's unfamiliar to the audience.

## After the POC

Check warning on line 308 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L308

'After the POC' should use sentence-style capitalization.

Check warning on line 308 in poc-onboarding.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

poc-onboarding.mdx#L308

Spell out 'POC', if it's unfamiliar to the audience.

<Card title="Go-live checklist" icon="file-check" horizontal href="/migration-services/go-live-checklist">
Review everything to configure and verify before launch.
</Card>
</Card>
6 changes: 3 additions & 3 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

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

this is a test update

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Test text on Quickstart page

High Severity

The phrase this is a test update is visible body copy on the Quickstart page, a primary entry point for new users. This looks like leftover draft text rather than intended documentation.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 11c883c. Configure here.


After you complete this guide, you'll have a live documentation site ready to customize and update.

<Visibility for="humans">
Expand All @@ -30,15 +32,13 @@
2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`.
3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account.
4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run:

```bash
mint signup \
--firstName <first-name> \
--lastName <last-name> \
--company <company> \
--email <email>
```

`mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details.
5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry.
6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new <directory> --name <name> --theme <theme>` or `mint new <directory> --template <template-name>`. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files.
Expand Down Expand Up @@ -73,7 +73,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 `.mintlify.site` URL loads.

Check warning on line 76 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L76

Use semicolons judiciously.
</Visibility>

## View your deployed site
Expand Down Expand Up @@ -209,4 +209,4 @@

<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
</Card>
Empty file added untitled-page-2.mdx
Empty file.
3 changes: 3 additions & 0 deletions untitled-page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: "Untitled Page"
---

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 untitled page committed

Low Severity

A new untitled-page.mdx file contains only a placeholder title and no content, and it is not referenced in docs.json. This looks like a leftover editor stub rather than a real page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 11c883c. Configure here.