From 2e3857eaaa14492f2d9bf03d116cabd3b5f78155 Mon Sep 17 00:00:00 2001 From: Mayank Shouche <43075711+mayankshouche@users.noreply.github.com> Date: Thu, 14 Nov 2024 10:45:21 -0800 Subject: [PATCH 1/4] Documentation edits made through Mintlify web editor --- settings/navigation.mdx | 65 ++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 34 deletions(-) diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 6bcb1517..aff62bc7 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -12,6 +12,7 @@ documentation. They show up above the main sidebar. + @@ -52,10 +53,8 @@ Anchors provide another way to direct users to sections of your documentation, or link out to external URLs. - + + @@ -136,7 +135,7 @@ Create groups by recursively nesting a group within a group. Simply put your MDX files in folders and update the paths in `mint.json`. -For example, to have a page at `https://yoursite.com/your-folder/your-page` you +For example, to have a page at [`https://yoursite.com/your-folder/your-page`](https://yoursite.com/your-folder/your-page) you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`. @@ -148,31 +147,29 @@ would make a folder called `your-folder` containing an MDX file called - -```json Navigation With Folder -"navigation": [ - { - "group": "Group Name", - "pages": ["your-folder/your-page"] - } -] -``` - -```json Nested Navigation -"navigation": [ - { - "group": "Getting Started", - "pages": [ - "quickstart", - { - "group": "Nested Reference Pages", - "pages": ["nested-reference-page"] - } - ] - } -] -``` - + ```json Navigation With Folder + "navigation": [ + { + "group": "Group Name", + "pages": ["your-folder/your-page"] + } + ] + ``` + + ```json Nested Navigation + "navigation": [ + { + "group": "Getting Started", + "pages": [ + "quickstart", + { + "group": "Nested Reference Pages", + "pages": ["nested-reference-page"] + } + ] + } + ] + ``` ### Hidden Pages @@ -208,17 +205,17 @@ The `topbarLinks` field supports the following fields: `name`, `url`. ### CTA Button -Customize the call-to-action (CTA) button in the topbar using the `topbarCTA` +Customize the call-to-action (CTA) button in the topbar using the `topbarCtaButton` field. -The `topbarCTA` field supports the following fields: `name`, `url`, and `type`. +The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](settings/global#structure). ```json - "topbarCTA": { + "topbarCtaButton": { "name": "Get Started", "url": "https://mintlify.com/get-started" } @@ -238,4 +235,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`. "type": "github", "url": "https://github.com/mintlify/docs" } -``` +``` \ No newline at end of file From e97f7ecd57948945b1b9ab8a52fe879759bf9c9b Mon Sep 17 00:00:00 2001 From: Mayank Shouche <43075711+mayankshouche@users.noreply.github.com> Date: Thu, 14 Nov 2024 10:51:10 -0800 Subject: [PATCH 2/4] Documentation edits made through Mintlify web editor --- settings/navigation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/navigation.mdx b/settings/navigation.mdx index aff62bc7..60f66bd0 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -212,7 +212,7 @@ field. -The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](settings/global#structure). +The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](/settings/global#structures). ```json "topbarCtaButton": { From 37d2fcad974054d0eb4e552c88f1f4a7598619ad Mon Sep 17 00:00:00 2001 From: Mayank Shouche <43075711+mayankshouche@users.noreply.github.com> Date: Thu, 14 Nov 2024 10:56:16 -0800 Subject: [PATCH 3/4] Documentation edits made through Mintlify web editor --- settings/navigation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 60f66bd0..e3c76db7 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -212,7 +212,7 @@ field. -The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](/settings/global#structures). +The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](/settings/global#structure). ```json "topbarCtaButton": { From 5f2d275062ffed50356f8806c26840af03c12b06 Mon Sep 17 00:00:00 2001 From: mayankshouche Date: Thu, 14 Nov 2024 11:36:16 -0800 Subject: [PATCH 4/4] remove erroneously added link --- settings/navigation.mdx | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/settings/navigation.mdx b/settings/navigation.mdx index e3c76db7..d0cd3dd0 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -1,7 +1,6 @@ --- title: "Navigation" -description: - "Organize your docs directory to guide your users to the information they need " +description: "Organize your docs directory to guide your users to the information they need " icon: "map" --- @@ -135,7 +134,7 @@ Create groups by recursively nesting a group within a group. Simply put your MDX files in folders and update the paths in `mint.json`. -For example, to have a page at [`https://yoursite.com/your-folder/your-page`](https://yoursite.com/your-folder/your-page) you +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`. @@ -156,20 +155,21 @@ would make a folder called `your-folder` containing an MDX file called ] ``` - ```json Nested Navigation - "navigation": [ - { - "group": "Getting Started", - "pages": [ - "quickstart", - { - "group": "Nested Reference Pages", - "pages": ["nested-reference-page"] - } - ] - } - ] - ``` +```json Nested Navigation +"navigation": [ + { + "group": "Getting Started", + "pages": [ + "quickstart", + { + "group": "Nested Reference Pages", + "pages": ["nested-reference-page"] + } + ] + } +] +``` + ### Hidden Pages @@ -235,4 +235,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`. "type": "github", "url": "https://github.com/mintlify/docs" } -``` \ No newline at end of file +```