From d65b36c199bfacef1c3c4c3a7c911c715beccd4a Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:31:22 -0700 Subject: [PATCH 1/4] clean up headers --- installation.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/installation.mdx b/installation.mdx index f0e43395d..758cd3e9b 100644 --- a/installation.mdx +++ b/installation.mdx @@ -1,6 +1,6 @@ --- title: "CLI installation" -description: "Install the CLI to preview and develop your docs locally" +description: "Use the CLI to preview and maintain your documentation locally" --- Decorative graphic representing the CLI. -## Installing the CLI +## Install the CLI **Prerequisite**: Please install [Node.js](https://nodejs.org/en) before proceeding. @@ -86,7 +86,7 @@ If you attempt to run on a port that is already in use, it will use the next ava Port 3000 is already in use. Trying 3001 instead. ``` -## Previewing as a specific group +## Preview as a specific group If you use partial authentication to restrict access to your documentation, you can preview as a specific authentication group by using the `--groups [groupname]` flag. From 4031131035e98ba7d62dbaf21e594c47cc5e410b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:35:44 -0700 Subject: [PATCH 2/4] add node version prerequisite to installation --- installation.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/installation.mdx b/installation.mdx index 758cd3e9b..3bfe0d6c7 100644 --- a/installation.mdx +++ b/installation.mdx @@ -17,11 +17,11 @@ description: "Use the CLI to preview and maintain your documentation locally" ## Install the CLI - **Prerequisite**: Please install [Node.js](https://nodejs.org/en) before proceeding. + **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. - + Run the following command to install the [CLI](https://www.npmjs.com/package/mint): @@ -35,7 +35,7 @@ description: "Use the CLI to preview and maintain your documentation locally" - + Navigate to your docs directory (where your `docs.json` file is located) and execute the following command: ```bash From 8ba801b6f94cc6db0de1a1c248a3ba724a72266f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:38:29 -0700 Subject: [PATCH 3/4] add intro for CLI --- installation.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/installation.mdx b/installation.mdx index 3bfe0d6c7..a93371b50 100644 --- a/installation.mdx +++ b/installation.mdx @@ -14,6 +14,10 @@ description: "Use the CLI to preview and maintain your documentation locally" alt="Decorative graphic representing the CLI." /> +Use the CLI to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems. + +The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats. + ## Install the CLI From 5f8cc9ff33148cc88e66bc7b20d2b5835517917f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 20 Oct 2025 09:39:54 -0700 Subject: [PATCH 4/4] add node version to quickstart --- quickstart.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 73d1d3c9f..967a25369 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -79,6 +79,10 @@ The code-based workflow integrates with your existing development environment an ### Install the CLI + + **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. + + To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: @@ -91,10 +95,6 @@ To work locally with your documentation, install the Command Line Interface (CLI ``` - - You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide. - - ### Edit the documentation After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: