Skip to content

Commit f6c0961

Browse files
authored
Add info on migrating to docs.json from mint.json (#838)
* remove outdated `mint.json` references * add upgrading steps
1 parent 4fcc4e7 commit f6c0961

File tree

2 files changed

+52
-5
lines changed

2 files changed

+52
-5
lines changed

changelog.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ mode: "center"
108108
mint upgrade
109109
```
110110

111-
1. Delete your old mint.json file and push your changes
111+
1. Delete your old `mint.json` file and push your changes
112112

113113
## CI Checks
114114

@@ -144,7 +144,7 @@ mode: "center"
144144
- New UI with dedicated chat page & pre-filled prompts
145145
- Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
146146
- More robust knowledge for adding & editing components
147-
- Improved mint.json file editing
147+
- Improved `docs.json` file editing
148148

149149
## Partial Authentication
150150

@@ -242,7 +242,7 @@ mode: "center"
242242

243243
## Light mode code blocks
244244

245-
Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`:
245+
Code blocks now have a light mode variant which can be enabled by adding the following to your `docs.json`:
246246

247247
```json
248248
"codeBlock": {
@@ -409,11 +409,11 @@ mode: "center"
409409
<Update label="June 2024">
410410
## Launch Week Highlights
411411

412-
- Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `mint.json` file and it'll update your docs styling.
412+
- Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `docs.json` file and it'll update your docs styling.
413413
- Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated search bar UI.
414414
- Web Editor branching: create branches in our web editor without an IDE.
415415
- User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.
416-
- OepenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the mint.json.
416+
- OpenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the `docs.json`.
417417
</Update>
418418

419419
<Update label="May 2024">

settings.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,3 +1396,50 @@ See [Themes](themes) for more information.
13961396
```
13971397
</Tab>
13981398
</Tabs>
1399+
1400+
## Upgrading from `mint.json`
1401+
1402+
If your docs project uses the deprecated `mint.json` file, follow these steps to upgrade to `docs.json`.
1403+
1404+
<Steps>
1405+
<Step title="Install or update the CLI">
1406+
If you haven't installed the [CLI](/installation), install it now:
1407+
1408+
<CodeGroup>
1409+
1410+
```bash npm
1411+
npm i -g mint
1412+
```
1413+
1414+
1415+
```bash yarn
1416+
yarn global add mint
1417+
```
1418+
1419+
1420+
```bash pnpm
1421+
pnpm add -g mint
1422+
```
1423+
1424+
</CodeGroup>
1425+
1426+
If you already have the CLI installed, make sure it is up to date:
1427+
1428+
```bash
1429+
mint update
1430+
```
1431+
1432+
</Step>
1433+
<Step title="Create your docs.json file">
1434+
In your docs repository, run:
1435+
1436+
```bash
1437+
mint upgrade
1438+
```
1439+
1440+
This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.
1441+
</Step>
1442+
<Step title="Delete your mint.json file">
1443+
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
1444+
</Step>
1445+
</Steps>

0 commit comments

Comments
 (0)