Docs.json updates to docs

Author: ruhanponnada

README.md

@@ -16,7 +16,14 @@ Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview th
 npm i -g mintlify
 ```
 
-Run the following command at the root of your documentation (where mint.json is)
+**Note**: Please upgrade to ```docs.json``` before proceeding and delete the legacy ```mint.json``` file.
+To upgrade, run the following command at the root of your documentation (where docs.json is)
+
+```
+mintlify upgrade
+```
+
+Run the following command at the root of your documentation (where docs.json is)
 
 ```
 mintlify dev
@@ -29,4 +36,4 @@ Install our Github App to auto propagate changes from your repo to your deployme
 #### Troubleshooting
 
 - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
-- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
+- Page loads as a 404 - Make sure you are running in a folder with `docs.json`

development.mdx

@@ -4,7 +4,8 @@ description: 'Preview changes locally to update your docs'
 ---
 
 <Info>
-  **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
+  **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. <br />
+  Please upgrade to ```docs.json``` before proceeding and delete the legacy ```mint.json``` file.
 </Info>
 
 Follow these steps to install and run Mintlify on your operating system:
@@ -23,7 +24,7 @@ yarn global add mintlify
 
 </CodeGroup>
 
-**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
+**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
 
 ```bash
 mintlify dev

essentials/navigation.mdx

@@ -1,12 +1,12 @@
 ---
 title: 'Navigation'
-description: 'The navigation field in mint.json defines the pages that go in the navigation menu'
+description: 'The navigation field in docs.json defines the pages that go in the navigation menu'
 icon: 'map'
 ---
 
 The navigation menu is the list of links on every website.
 
-You will likely update `mint.json` every time you add a new page. Pages do not show up automatically.
+You will likely update `docs.json` every time you add a new page. Pages do not show up automatically.
 
 ## Navigation syntax
 
@@ -15,34 +15,48 @@ Our navigation syntax is recursive which means you can make nested navigation gr
 <CodeGroup>
 
 ```json Regular Navigation
-"navigation": [
+"navigation": {
+  "tabs": [
     {
-        "group": "Getting Started",
-        "pages": ["quickstart"]
+      "tab": "Docs",
+      "groups": [
+        {
+          "group": "Getting Started",
+          "pages": ["quickstart"]
+        }
+      ]
     }
-]
+  ]
+}
 ```
 
 ```json Nested Navigation
-"navigation": [
+"navigation": {
+  "tabs": [
     {
-        "group": "Getting Started",
-        "pages": [
+      "tab": "Docs",
+      "groups": [
+        {
+          "group": "Getting Started",
+          "pages": [
             "quickstart",
             {
-                "group": "Nested Reference Pages",
-                "pages": ["nested-reference-page"]
+              "group": "Nested Reference Pages",
+              "pages": ["nested-reference-page"]
             }
-        ]
+          ]
+        }
+      ]
     }
-]
+  ]
+}
 ```
 
 </CodeGroup>
 
 ## Folders
 
-Simply put your MDX files in folders and update the paths in `mint.json`.
+Simply put your MDX files in folders and update the paths in `docs.json`.
 
 For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.
 
@@ -53,14 +67,21 @@ You cannot use `api` for the name of a folder unless you nest it inside another
 </Warning>
 
 ```json Navigation With Folder
-"navigation": [
+"navigation": {
+  "tabs": [
     {
-        "group": "Group Name",
-        "pages": ["your-folder/your-page"]
+      "tab": "Docs",
+      "groups": [
+        {
+          "group": "Group Name",
+          "pages": ["your-folder/your-page"]
+        }
+      ]
     }
-]
+  ]
+}
 ```
 
 ## Hidden Pages
 
-MDX files not included in `mint.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.
+MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.

essentials/settings.mdx

@@ -1,10 +1,10 @@
 ---
 title: 'Global Settings'
-description: 'Mintlify gives you complete control over the look and feel of your documentation using the mint.json file'
+description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file'
 icon: 'gear'
 ---
 
-Every Mintlify site needs a `mint.json` file with the core configuration settings. Learn more about the [properties](#properties) below.
+Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.
 
 ## Properties
 

quickstart.mdx

@@ -20,11 +20,22 @@ Learn how to update your docs locally and deploy them to the public.
   </Accordion>
   <Accordion icon="rectangle-terminal" title="Preview changes">
     Previewing helps you make sure your changes look as intended. We built a
-    command line interface to render these changes locally. 1. Install the
+    command line interface to render these changes locally. 
+    1. Install the
     [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
     documentation changes locally with this command: ``` npm i -g mintlify ```
     2. Run the following command at the root of your documentation (where
-    `mint.json` is): ``` mintlify dev ```
+    `docs.json` is): ``` mintlify dev ```
+    <Note>
+      If you’re currently using the legacy ```mint.json``` configuration file, please update the Mintlify CLI:
+
+
+      ```npm i -g mintlify@latest```
+      And run the new upgrade command in your docs repository:
+
+      ```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>
   </Accordion>
 </AccordionGroup>
 
@@ -55,32 +66,32 @@ Add content directly in your files with MDX syntax and React components. You can
 
 <CardGroup>
 
-<Card title="Style Your Docs" icon="paintbrush" href="/settings/global">
-  Add flair to your docs with personalized branding.
+<Card title="Add Content With MDX" icon="file" href="/essentials/markdown">
+  Add content to your docs with MDX syntax.
 </Card>
 
 <Card
-  title="Add API Endpoints"
+  title="Add Code Blocks"
   icon="square-code"
-  href="/api-playground/configuration"
+  href="/essentials/code"
 >
-  Implement your OpenAPI spec and enable API user interaction.
+  Add code directly to your docs with syntax highlighting.
 </Card>
 
 <Card
-  title="Integrate Analytics"
-  icon="chart-mixed"
-  href="/analytics/supported-integrations"
+  title="Add Images"
+  icon="image"
+  href="/essentials/images"
 >
-  Draw insights from user interactions with your documentation.
+  Add images to your docs to make them more engaging.
 </Card>
 
 <Card
-  title="Host on a Custom Domain"
-  icon="browser"
-  href="/settings/custom-domain/subdomain"
+  title="Add Custom Components"
+  icon="puzzle-piece"
+  href="/essentials/reusable-snippets"
 >
-  Keep your docs on your own website's subdomain.
+  Add templates to your docs to make them more reusable.
 </Card>
 
 </CardGroup>