Skip to content
Merged
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
4 changes: 2 additions & 2 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,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 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

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 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

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 @@ -113,7 +113,7 @@

### 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.
If you use group-based access control to restrict access to your documentation, you can preview as a specific authentication group by using the `--groups [groupname]` flag.

For example, if you have a group named `admin`, you can preview as a member of that group with the command:

Expand Down Expand Up @@ -181,7 +181,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 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

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

### Find accessibility issues

Expand Down Expand Up @@ -211,7 +211,7 @@

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication)
- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Check OpenAPI spec
Expand Down Expand Up @@ -294,7 +294,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 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

Use 'app' instead of 'application'.

Check warning on line 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

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