From 11c883c04ad78b400c04a4a86878621620c9a0a1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 21:43:28 +0000 Subject: [PATCH] Updated mintlify pages - Updated agent/use-cases.mdx - Updated optimize/pdf-exports.mdx - Updated cli/index.mdx - Updated poc-onboarding.mdx - Updated quickstart.mdx - Created untitled-page-2.mdx - Created untitled-page.mdx - Updated docs.json Mintlify-Source: dashboard-editor --- agent/use-cases.mdx | 2 ++ cli/index.mdx | 18 +++++++++++++----- docs.json | 3 ++- optimize/pdf-exports.mdx | 20 ++++++++++---------- poc-onboarding.mdx | 26 +++++++++----------------- quickstart.mdx | 6 +++--- untitled-page-2.mdx | 0 untitled-page.mdx | 3 +++ 8 files changed, 42 insertions(+), 36 deletions(-) create mode 100644 untitled-page-2.mdx create mode 100644 untitled-page.mdx diff --git a/agent/use-cases.mdx b/agent/use-cases.mdx index 66e510f844..41d8d2c42a 100644 --- a/agent/use-cases.mdx +++ b/agent/use-cases.mdx @@ -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. + +/ \ No newline at end of file diff --git a/cli/index.mdx b/cli/index.mdx index ea54fbc3bd..81cfa3d960 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -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'; + Decorative graphic representing the CLI. Decorative graphic representing the CLI. ## About the CLI @@ -28,21 +30,27 @@ The CLI runs on your machine and connects to your Mintlify deployment when you n ### 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. @@ -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. \ No newline at end of file diff --git a/docs.json b/docs.json index ead71c90ad..7f2b3fdfad 100644 --- a/docs.json +++ b/docs.json @@ -218,7 +218,8 @@ "group": "Export your site", "pages": [ "deploy/export", - "optimize/pdf-exports" + "optimize/pdf-exports", + "untitled-page-2" ] }, { diff --git a/optimize/pdf-exports.mdx b/optimize/pdf-exports.mdx index 76cb4ddb68..f943b1c599 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -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. -## 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. @@ -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. \ No newline at end of file diff --git a/poc-onboarding.mdx b/poc-onboarding.mdx index ed137ab19e..37f2b8721b 100644 --- a/poc-onboarding.mdx +++ b/poc-onboarding.mdx @@ -16,7 +16,7 @@ Use this guide to set up a working documentation site and evaluate Mintlify with 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. | @@ -32,7 +32,7 @@ Your repository remains the source of truth. The dashboard lets you edit, config ### Identify participants | Role | Responsibility | Time needed | -|---|---|---| +| --- | --- | --- | | Documentation owner | Runs the POC and completes most steps. | A few hours total | | GitHub administrator | Approves the Mintlify GitHub App. | 15 minutes | | Designer or brand owner | Provides logos, colors, and fonts. | 30 minutes | @@ -78,13 +78,11 @@ Share the goal, baseline, and criteria with your AE or SE. Go to [mintlify.com/start](https://mintlify.com/start) and sign up with your work email address. - 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. - Ask your GitHub administrator to install the Mintlify GitHub App. Grant access to the documentation repository by selecting **Only select repositories**. @@ -96,7 +94,6 @@ Share the goal, baseline, and criteria with your AE or SE. 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). - After the starter content deploys, find your URL on the **Overview** page of the [dashboard](https://app.mintlify.com/). Open the `https://.mintlify.site` URL and confirm that it loads. @@ -143,7 +140,6 @@ Keep the sample under 50 pages so you can focus on migration quality. See [Enterprise migrations](/migration-services/enterprise) for the full migration process. - Use one of these methods: @@ -153,7 +149,6 @@ Keep the sample under 50 pages so you can focus on migration quality. See [Migrate to Mintlify](/migration) for other platforms. - 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). @@ -176,23 +171,20 @@ Ask a writer who does not use Git to complete this step. - 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. - Edit the page in the visual editor. Type `/` to insert a component or drag an image onto the page to upload it. - Press Cmd + Shift + S (macOS) or Ctrl + Shift + S (Windows) to switch between the rendered visual mode and the MDX source. + Press Cmd \+ Shift \+ S (macOS) or Ctrl \+ Shift \+ S (Windows) to switch between the rendered visual mode and thePress Cmd \+ Shift \+ S (macOS) or Ctrl \+ Shift \+ S (Windows) to switch between the rendered visual mode and the MDX source. - - 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. - - 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. @@ -286,7 +278,7 @@ Choose the workflow most relevant to your evaluation: Book one hour with your decision maker. Start with the goal and baseline you defined before the POC, then review: | 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. | @@ -302,7 +294,7 @@ Resolve open questions with your AE or SE before this meeting. Most POCs take two to three weeks: | 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. | @@ -317,4 +309,4 @@ Most POCs take two to three weeks: Review everything to configure and verify before launch. - + \ No newline at end of file diff --git a/quickstart.mdx b/quickstart.mdx index 9b1d56b45c..f115824c20 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -7,6 +7,8 @@ boost: 3 import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; +this is a test update + After you complete this guide, you'll have a live documentation site ready to customize and update. @@ -30,7 +32,6 @@ After you complete this guide, you'll have a live documentation site ready to cu 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 \ @@ -38,7 +39,6 @@ After you complete this guide, you'll have a live documentation site ready to cu --company \ --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 --name --theme ` or `mint new --template `. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files. @@ -209,4 +209,4 @@ Find your exact URL on the **Overview** page of your [dashboard](https://app.min Use your own domain for your documentation site. - + \ No newline at end of file diff --git a/untitled-page-2.mdx b/untitled-page-2.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/untitled-page.mdx b/untitled-page.mdx new file mode 100644 index 0000000000..58a5d5afa0 --- /dev/null +++ b/untitled-page.mdx @@ -0,0 +1,3 @@ +--- +title: "Untitled Page" +--- \ No newline at end of file