Skip to content

Update CLI upgrade docs to reflect automatic migration #5072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Update CLI upgrade docs to reflect automatic migration #5072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 1 addition & 5 deletions installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,11 +334,7 @@

### Upgrade configuration

Convert a `mint.json` configuration file to the current `docs.json` format:

```bash
mint upgrade
```
The CLI automatically converts a `mint.json` configuration file to `docs.json` when you run `mint dev`, `mint broken-links`, or `mint rename`. No manual step is required.

Check warning on line 337 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L337 

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

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

Expand Down
8 changes: 2 additions & 6 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,9 @@ If your project uses the deprecated `mint.json` file, follow these steps to upgr
```
</Step>
<Step title="Create your docs.json file">
In your docs repository, run:
Run any CLI command such as `mint dev` in your docs repository. The CLI automatically detects `mint.json` and converts it to `docs.json`.

```bash
mint upgrade
```

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 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