Skip to content
Closed
Show file tree
Hide file tree
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
30 changes: 23 additions & 7 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -332,22 +332,38 @@
| `--overwrite` | Overwrite existing files. |
| `--no-writeFiles` | Preview output without writing files. |

### Upgrade configuration
### Check version

Convert a `mint.json` configuration file to the current `docs.json` format:
Display the current CLI and client version:

```bash
mint upgrade
mint version
```

See [Global settings](/organize/settings) for more information about `docs.json`.
## Telemetry

### Check version
The CLI collects anonymous usage telemetry to help improve Mintlify. No personal or project data is collected. Telemetry is enabled by default and can be disabled at any time.

Check warning on line 345 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L345

In general, use active voice instead of passive voice ('is collected').

Check warning on line 345 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L345

In general, use active voice instead of passive voice ('is enabled').

Check warning on line 345 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L345

In general, use active voice instead of passive voice ('be disabled').

Display the current CLI and client version:
To disable telemetry:

```bash
mint version
mint --telemetry false
```

To re-enable telemetry:

```bash
mint --telemetry true
```

You can also disable telemetry by setting either of these environment variables:

```bash
MINTLIFY_TELEMETRY_DISABLED=1
```

```bash
DO_NOT_TRACK=1
```

## Formatting
Expand Down
10 changes: 5 additions & 5 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ If a `$ref` resolves to an object, Mintlify merges any sibling keys in the same

## Upgrading from `mint.json`

If your project uses the deprecated `mint.json` file, follow these steps to upgrade to `docs.json`.
If your project uses the deprecated `mint.json` file, the CLI automatically upgrades it to `docs.json` when you run `mint dev`, `mint broken-links`, or `mint rename`.

<Steps>
<Step title="Install or update the CLI">
Expand Down Expand Up @@ -144,14 +144,14 @@ If your project uses the deprecated `mint.json` file, follow these steps to upgr
mint update
```
</Step>
<Step title="Create your docs.json file">
In your docs repository, run:
<Step title="Run any CLI command to auto-upgrade">
Run `mint dev` in your docs repository. The CLI detects your `mint.json` and automatically creates a `docs.json` file:

```bash
mint upgrade
mint dev
```

This command creates a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.
Review the generated `docs.json` file to ensure all settings are correct.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file.
Expand Down
Loading