Skip to content

Fix docs to reflect new docs.json standards and best practices + localization page update #511

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 2 commits into from
Feb 6, 2025
Merged

Fix docs to reflect new docs.json standards and best practices + localization page update #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
982dad7
Fixed urls and small docs.json updates
ruhanponnada Feb 6, 2025
43448d8
Fixed localization page
ruhanponnada Feb 6, 2025
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
3 changes: 0 additions & 3 deletions migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@

</path>
</g>
</svg>} />
<Card title="GitBook" horizontal icon={<svg className="h-6 w-6" width="36" height="36" viewBox="0 0 65 65" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M27.3964 34.2196C30.5255 36.0256 32.09 36.9286 33.8083 36.9301C35.5265 36.9316 37.0926 36.0314 40.2249 34.2308L60.1914 22.7535C61.0927 22.2354 61.6484 21.275 61.6484 20.2353C61.6484 19.1956 61.0927 18.2352 60.1914 17.7171L40.2177 6.23561C37.0888 4.43703 35.5243 3.53774 33.8078 3.53841C32.0912 3.53908 30.5275 4.43959 27.4 6.24061L10.2293 16.1287C10.102 16.202 10.0384 16.2386 9.97907 16.2733C4.1137 19.7069 0.489885 25.9755 0.441431 32.7718C0.440941 32.8405 0.440941 32.9139 0.440941 33.0608C0.440941 33.2075 0.440941 33.2808 0.44143 33.3494C0.489777 40.1381 4.10551 46.4008 9.96043 49.8371C10.0196 49.8719 10.0831 49.9085 10.2102 49.9819L20.9659 56.1919C27.2332 59.8105 30.3668 61.6197 33.8081 61.6209C37.2493 61.6221 40.3842 59.8149 46.6539 56.2006L58.008 49.6552C61.1474 47.8454 62.7171 46.9406 63.579 45.4488C64.4409 43.957 64.4409 42.1452 64.4409 38.5215V31.5213C64.4409 30.516 63.8965 29.5896 63.0182 29.1004C62.1683 28.6271 61.1325 28.6341 60.2891 29.1189L37.0074 42.5019C35.4454 43.3999 34.6643 43.8488 33.8072 43.8491C32.9502 43.8493 32.1689 43.4008 30.6063 42.5039L14.8487 33.4587C14.0594 33.0056 13.6647 32.779 13.3477 32.7381C12.625 32.6449 11.9301 33.0497 11.6548 33.7244C11.5341 34.0204 11.5365 34.4754 11.5414 35.3855C11.545 36.0556 11.5468 36.3906 11.6094 36.6987C11.7497 37.3888 12.1127 38.0137 12.6428 38.4772C12.8795 38.6842 13.1696 38.8517 13.7499 39.1866L30.5974 48.9103C32.1641 49.8145 32.9474 50.2666 33.8075 50.2669C34.6677 50.2671 35.4513 49.8154 37.0184 48.9121L57.6684 37.0086C58.2037 36.7 58.4714 36.5458 58.6721 36.6617C58.8727 36.7777 58.8727 37.0866 58.8727 37.7045V40.8796C58.8727 41.7856 58.8727 42.2385 58.6572 42.6115C58.4417 42.9844 58.0493 43.2107 57.2644 43.6631L40.2322 53.4811C37.0966 55.2886 35.5288 56.1923 33.8079 56.1915C32.0869 56.1908 30.5199 55.2856 27.386 53.4752L11.4509 44.2702C11.4003 44.2409 11.375 44.2263 11.3514 44.2125C8.01023 42.2601 5.94859 38.6883 5.92925 34.8185C5.92911 34.7912 5.92911 34.762 5.92911 34.7035V31.7889C5.92911 29.6526 7.06688 27.6781 8.91512 26.6068C10.5483 25.6601 12.5628 25.6582 14.1977 26.6019L27.3964 34.2196Z" fill="#4088ff"/>
</svg>} />
<Card title="ReadMe" horizontal icon={<svg fill="#177fc4" className="h-6 w-6" width="36" height="36" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
<path d="M29.35 4.361h-7.767c-2.672 0-4.994 1.85-5.578 4.461-0.589-2.611-2.906-4.461-5.578-4.461h-7.761c-1.472 0-2.667 1.194-2.667 2.667v13.656c0 1.472 1.194 2.667 2.667 2.667h4.983c5.678 0 7.372 1.355 8.183 4.167 0.039 0.156 0.289 0.156 0.333 0 0.817-2.811 2.511-4.167 8.183-4.167h4.983c1.472 0 2.667-1.194 2.667-2.667v-13.65c0-1.467-1.183-2.661-2.65-2.672zM13.444 19.105c0 0.106-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.272c0-0.105 0.083-0.194 0.194-0.194h8.911c0.105 0 0.194 0.083 0.194 0.194v1.272zM13.444 15.722c0 0.105-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.272c0-0.106 0.083-0.194 0.194-0.194h8.911c0.105 0 0.194 0.083 0.194 0.194v1.272zM13.444 12.339c0 0.105-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.272c0-0.105 0.083-0.194 0.194-0.194h8.911c0.105 0 0.194 0.083 0.194 0.194v1.272zM27.85 19.1c0 0.105-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.272c0-0.105 0.083-0.194 0.194-0.194h8.911c0.106 0 0.194 0.083 0.194 0.194v1.272zM27.85 15.717c0 0.106-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.272c0-0.105 0.083-0.194 0.194-0.194h8.911c0.106 0 0.194 0.083 0.194 0.194v1.272zM27.85 12.333c0 0.105-0.083 0.194-0.194 0.194h-8.906c-0.105 0-0.194-0.083-0.194-0.194v-1.267c0-0.105 0.083-0.194 0.194-0.194h8.911c0.106 0 0.194 0.083 0.194 0.194v1.267z"/>
Expand Down Expand Up @@ -136,7 +133,7 @@
Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint.


```

Check warning on line 136 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

migration.mdx#L136 

Did you really mean 'frontmatter'?
mintlify-scrape openapi-file [openApiFilename]

-w, --writeFiles Whether or not to write the frontmatter files [boolean] [default: true]
Expand Down
4 changes: 2 additions & 2 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
The eyebrows style of the content. Defaults to `section`.
</ResponseField>
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot;">
The codeblock theme. Defaults to `system`.

Check warning on line 111 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L111 

Did you really mean 'codeblock'?
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -127,7 +127,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
The font family, such as "Open Sans", "Playfair Display"

Check warning on line 130 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L130 

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
Expand All @@ -136,7 +136,7 @@
The font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
The font format, can be one of woff, woff2

Check warning on line 139 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L139 

Did you really mean 'woff'?
</ResponseField>
<ResponseField name="heading" type="object">

Expand Down Expand Up @@ -295,7 +295,7 @@
Whether the current option is default hidden
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
A valid path or external link
An external link
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -314,7 +314,7 @@
Whether the current option is default hidden
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
A valid path or external link
An external link
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -1478,14 +1478,14 @@
"pages": ["analytics/posthog"]
}
],
"footerSocials": {

Check warning on line 1481 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1481 

Did you really mean 'footerSocials'?
"github": "https://github.com/mintlify",
"slack": "https://mintlify.com/community",
"x": "https://x.com/mintlify"
},
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"

Check warning on line 1488 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1488 

Did you really mean 'frontchat'?
}
}
```
Expand Down
14 changes: 7 additions & 7 deletions settings/navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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.

<Frame>
<img className="block rounded-md" src="/images/topbar-links.png" />
Expand All @@ -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.

<Frame>
Expand Down
16 changes: 10 additions & 6 deletions settings/versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
title: "Versioning & Localization"
description: "Build separate versions or localizations"
icon: "square-chevron-down"
Expand All @@ -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"
}
]
}
Expand Down Expand Up @@ -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`).

Expand All @@ -196,7 +200,7 @@ We currently support localization in English (`en`), Chinese (`cn`), Spanish (`e
```

<Tip>
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`.
</Tip>

Expand Down
Loading