Skip to content

Add instructions to upgrade from mint.json to global settings file #507

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

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Add instructions to upgrade from mint.json to global settings file #507

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
15 changes: 15 additions & 0 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ icon: "wrench"

Every documentation site requires a `docs.json` file that contains the core configuration settings. This file controls everything from styling and navigation to integrations and analytics.

<Note>
If you're currently using the legacy `mint.json` configuration file, please update the Mintlify CLI:

```sh
npm i -g mintlify@latest
```

And run the new `upgrade` command in your docs repository:
```sh
mintlify upgrade
```

You should now be using the new `docs.json` configuration file. Feel free to delete the `mint.json` file from your repository.
</Note>

## Properties

### Customization
Expand Down