mintlify · ethanpalm · Jun 13, 2025 · Jun 12, 2025 · Jun 12, 2025 · Jun 12, 2025
diff --git a/changelog.mdx b/changelog.mdx
@@ -13,8 +13,8 @@
 
   Learn more at [API playground docs.](/api-playground/)
 
-  ## npm i mint 
-  Can now use `npm i mint@latest -g` to upgrade your CLI.
+  ## `mint update`
+  Can now use `mint update` to update your CLI.
 </Update>
 
 <Update label="April 2025">
@@ -83,7 +83,7 @@
  - Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
  - Show code examples even when in simple mode for API playground
  - Support "command \+ k" shortcut for search in web editor
  - Codeblocks within callouts expand to fill the width of the callout area
 </Update>

 <Update label="February 2025">
@@ -114,9 +114,9 @@

  Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

  ## .md support for LLMs

  All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

  ## More Themes

@@ -198,7 +198,7 @@
  <Frame>
    ![llms.txt support](/images/changelog/llms.jpg)
  </Frame>
  All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

  ## Localization

@@ -270,7 +270,7 @@
  ## Dashboard Improvements

  - Added ability to change custom domain to be /docs directly through dashboard settings.
  - Consolidated the login and signup pages to decrease friction and confusion.
  - Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
  - Added login with Google OAuth
  - Added ability to add new deployment through dashboard settings.
@@ -284,7 +284,7 @@
  - Don't allow search engines to crawl user-auth protected pages.
  - Revalidate the cache when an org is deleted.
  - We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
  - Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.
  - Add in-line-style support for icons
  - Fixed the pop-in of custom CSS in docs.
  - Properly show in-line code styling in conjunction with links.
@@ -317,7 +317,7 @@
  <Frame>
    ![SEO Improvements](/images/changelog/seo-improvements.jpeg)
  </Frame>
  We've fixed  both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

  ## Dashboard Improvements

@@ -351,7 +351,7 @@

  ## File Uploads in API Playground

  By default, API playground requests are proxied by Mintlify. Now you can use
  `disableProxy` to disable this behavior and support request types like file
  uploads.

@@ -384,7 +384,7 @@
  </Frame>
  For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
  answer your users' questions when and where they asked. You can add this
  AI-powered chatbot to any web page: your landing page, inside your product, or
  on your existing documentation pages.

  - [Read the blog announcement](https://mintlify.com/blog/widget)
@@ -419,7 +419,7 @@
 <Update label="May 2024">
  ## Okta SSO

  We now support sign-on via Okta SAML and OIDC.

  ## Mintlify REST API

@@ -442,7 +442,7 @@
 <Update label="March 2024">
  ## Mintlify MDX for VSCode

  Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
 </Update>

 <Update label="February 2024">
@@ -451,7 +451,7 @@
  - Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
  - Versioning with tabs fully supported
  - Wildcard redirects now supported
  - CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
 </Update>

 <Update label="January 2024">

diff --git a/installation.mdx b/installation.mdx
@@ -1,5 +1,5 @@
 ---
-title: "Installation"
+title: "CLI"
 description: "Install the CLI to preview and develop your docs locally"
 icon: "terminal"
 ---
@@ -13,37 +13,45 @@ icon: "terminal"
   src="/images/installation/local-development-dark.png"
 />
 
+## Installing the CLI
+
 <Info>
   **Prerequisite**: Please install [Node.js](https://nodejs.org/en) (version 19 or higher) before proceeding.
 </Info>
 
-**Step 1**: Install the [CLI](https://www.npmjs.com/package/mint):
+<Steps>
+  <Step title="Install the CLI.">
+    Run the following command to install the [CLI](https://www.npmjs.com/package/mint):
+    <CodeGroup>
 
-<CodeGroup>
+    ```bash npm
+    npm i -g mint
+    ```
 
-```bash npm
-npm i -g mint
-```
 
-
-```bash yarn
-yarn global add mint
-```
+    ```bash yarn
+    yarn global add mint
+    ```
 
 
-```bash pnpm
-pnpm add -g mint
-```
+    ```bash pnpm
+    pnpm add -g mint
+    ```
 
-</CodeGroup>
+    </CodeGroup>
+  </Step>
+  <Step title="Preview locally.">
+    Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:
 
-**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
+    ```bash
+    mint dev
+    ```
 
-```bash
-mint dev
-```
+    A local preview of your documentation will be available at `http://localhost:3000`.
+  </Step>
+</Steps>
 
-Alternatively, if you do not want to install the CLI globally, you can use a run a one-time script:
+Alternatively, if you do not want to install the CLI globally, you can run a one-time script:
 
 <CodeGroup>
 
@@ -63,21 +71,24 @@ pnpm dlx mint dev
 
 </CodeGroup>
 
-A local preview of your documentation will be available at `http://localhost:3000`.
-
 ## Updates
 
-Each CLI release is associated with a specific version of the Mintlify platform. If your local preview doesn't align with the production version, please update the CLI:
+Each CLI release is associated with a specific version of the Mintlify platform. If your local preview is out of sync with the production version, please update the CLI:
 
 <CodeGroup>
 
+```bash mint
+mint update
+```
+
+
 ```bash npm
 npm i -g mint@latest
 ```
 
 
 ```bash yarn
-yarn global upgrade mint
+yarn global update mint
 ```
 
 
@@ -87,33 +98,33 @@ pnpm up --global mint
 
 </CodeGroup>
 
-## Custom Ports
+## Custom ports
 
 By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:
 
 ```bash
 mint dev --port 3333
 ```
 
-If you attempt to run on a port that's already in use, it will use the next available port:
+If you attempt to run on a port that is already in use, it will use the next available port:
 
 ```mdx
 Port 3000 is already in use. Trying 3001 instead.
 ```
 
-## Additional Commands
+## Additional commands
 
 While `mint dev` is the most commonly used command, there are other commands you can use to manage your documentation.
 
-### Find Broken Links
+### Finding broken links
 
 The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
 
 ```bash
 mint broken-links
 ```
 
-### Check OpenAPI Spec
+### Checking OpenAPI spec
 
 You can use the CLI to check your OpenAPI file for errors using the following command:
 
@@ -123,19 +134,17 @@ mint openapi-check <openapiFilenameOrUrl>
 
 You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
 
-### Renaming Files
+### Renaming files
 
-You can rename files using the following command:
+You can rename and update all references to files using the following command:
 
 ```bash
 mint rename <oldFilename> <newFilename>
 ```
 
-This is an improvement over updating the filename normally as it will also update all references to the file, ensuring no broken links.
-
 ## Formatting
 
-While developing locally, we recommend using extensions on your IDE to recognize and format MDX.
+While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files.
 
 If you use Cursor, Windsurf, or VSCode, we recommend the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
 
@@ -152,6 +161,11 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
     3. Reinstall the mint CLI: `npm install -g mint`
   </Accordion>
   <Accordion title="Issue: Encountering an unknown error">
-    Solution: Go to the root of your device and delete the ~/.mintlify folder. Afterwards, run `mint dev` again.
+    Solution: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.
+  </Accordion>
+  <Accordion title="Issue: The update command is not available">
+    If running `mint update` returns the command menu, your current version of the CLI does not include the `update` command.
+
+    Use `npm i -g mint@latest` to update the CLI.
   </Accordion>
 </AccordionGroup>