-
Notifications
You must be signed in to change notification settings - Fork 243
Draft from Aug 26 #7135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft from Aug 26 #7135
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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'; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unused OpenAPI import on CLI pageMedium Severity
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 | ||
|
|
@@ -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> | ||
|
|
@@ -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. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -218,7 +218,8 @@ | |
| "group": "Export your site", | ||
| "pages": [ | ||
| "deploy/export", | ||
| "optimize/pdf-exports" | ||
| "optimize/pdf-exports", | ||
| "untitled-page-2" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Empty page added to navigationMedium Severity The Export your site group now includes Reviewed by Cursor Bugbot for commit 11c883c. Configure here. |
||
| ] | ||
| }, | ||
| { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,8 @@ | |
|
|
||
| import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; | ||
|
|
||
| this is a test update | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Test text on Quickstart pageHigh Severity The phrase 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"> | ||
|
|
@@ -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. | ||
|
|
@@ -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. | ||
| </Visibility> | ||
|
|
||
| ## View your deployed site | ||
|
|
@@ -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> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
| title: "Untitled Page" | ||
| --- | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Empty untitled page committedLow Severity A new Reviewed by Cursor Bugbot for commit 11c883c. Configure here. |
||


There was a problem hiding this comment.
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.Reviewed by Cursor Bugbot for commit 11c883c. Configure here.