From 982dad74109f79351e4e92990dd194c3ceaa6941 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Wed, 5 Feb 2025 16:20:32 -0800 Subject: [PATCH 1/2] Fixed urls and small docs.json updates --- migration.mdx | 3 --- settings/global.mdx | 4 ++-- settings/navigation.mdx | 14 +++++++------- 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/migration.mdx b/migration.mdx index 491e89454..a0d8eaa3e 100644 --- a/migration.mdx +++ b/migration.mdx @@ -77,9 +77,6 @@ We currently support migration for: -} /> - - } /> diff --git a/settings/global.mdx b/settings/global.mdx index 8fe10b29f..657275ee5 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -295,7 +295,7 @@ The path to the favicon. Can be a single file or a pair for light and dark mode. Whether the current option is default hidden - A valid path or external link + An external link @@ -314,7 +314,7 @@ The path to the favicon. Can be a single file or a pair for light and dark mode. Whether the current option is default hidden - A valid path or external link + An external link diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 6ccb1d3dd..b5727b718 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -25,11 +25,11 @@ external link. "tabs": [ { "tab": "API References", - "href": "api-references" + "href": "https://your-website.com/api-reference" }, { "tab": "Content", - "href": "content" + "href": "https://your-website.com/content" }, { "tab": "Blog", @@ -63,12 +63,12 @@ added to your sidebar. More fields for anchors can be found { "anchor": "API References", "icon": "code", - "href": "api-references" + "href": "https://your-website.com/api-reference" }, { "anchor": "Content", "icon": "pencil", - "href": "content" + "href": "https://your-website.com/content" }, { "anchor": "Contact us", @@ -201,7 +201,7 @@ in your `docs.json` to `navigable`. ### Links -Add links to the topbar with the `topbarLinks` field in the `docs.json` file. +Add links to the topbar with the `links` field in the `docs.json` file. @@ -219,9 +219,9 @@ The `links` field supports the following fields: `label`, `href`. } ``` -### CTA Button +### Primary Button -Customize the call-to-action (CTA) button in the topbar using the `primary` +Customize the primary button in the topbar using the `primary` field. From 43448d88a06a9ca6b20fc4f7ce6dc7d89f5c050d Mon Sep 17 00:00:00 2001 From: Ruhan Date: Wed, 5 Feb 2025 16:31:44 -0800 Subject: [PATCH 2/2] Fixed localization page --- settings/versioning.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/settings/versioning.mdx b/settings/versioning.mdx index 0737fdbb4..5d59e544d 100644 --- a/settings/versioning.mdx +++ b/settings/versioning.mdx @@ -1,4 +1,4 @@ - --- +--- title: "Versioning & Localization" description: "Build separate versions or localizations" icon: "square-chevron-down" @@ -12,16 +12,20 @@ These guides will assume `v1` pages are in a folder named `v1`, `v2` pages are i ### Setup -Add `"versions": ["v2", "v1"]` to your `mint.json` file where `v1` and `v2` are the names of your versions. You can put any number of versions in this array. The first version from the array serves as the default version. +Add `"versions": ["v2", "v1"]` to your `docs.json` file where `v1` and `v2` are the names of your versions. You can put any number of versions in this array. The first version from the array serves as the default version. If you would like to specify a default version, you can do so like this: ```json "global": { "versions": [ { - "version": "version-name", + "version": "v1", "default": true, - "href": "link-to-version" + "href": "pathname-to-v1" + }, + { + "version": "v2", + "href": "pathname-to-v2" } ] } @@ -172,7 +176,7 @@ Common errors and how to fix them ### Setup -`"versions"` in your `mint.json` can be leveraged to create different language versions by adding a `locale` value to the version. The first localization from the array serves as the default localization. +`"languages"` in your `docs.json` can be leveraged to create different language versions by adding a `language` value to the version. The first language from the array serves as the default language. We currently support localization in English (`en`), Chinese (`cn`), Spanish (`es`), French (`fr`), Japanese (`jp`), Portuguese (`pt`), Portuguese (Brazil) (`pt-BR`), and German (`de`). @@ -196,7 +200,7 @@ We currently support localization in English (`en`), Chinese (`cn`), Spanish (`e ``` - The languages dropdown will show your localizations in the order you include + The languages dropdown will show your languages in the order you include them in the `docs.json`.