Skip to content
Closed
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 installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
keywords: ["CLI", "npm", "local development", "Node.js", "pnpm", "mint dev", "broken links", "accessibility"]
---

sup fella
Copy link

Choose a reason for hiding this comment

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

Informal text accidentally committed to documentation page

High Severity

The text sup fella appears to be a casual/debug message accidentally committed to the top of the production installation documentation page. This will be visible to all users visiting the installation docs.

Fix in Cursor Fix in Web


<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/installation/local-development-light.png"
Expand All @@ -15,13 +17,13 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) 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.

Check warning on line 20 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L20

Use 'capability' or 'feature' instead of 'functionality'.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 26 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L26

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally

Expand Down Expand Up @@ -181,7 +183,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 186 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L186

In general, use active voice instead of passive voice ('are reported').

### Find accessibility issues

Expand Down Expand Up @@ -294,7 +296,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 299 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L299

Use 'app' instead of 'application'.

Check warning on line 299 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L299

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

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down