Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
- Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
- Show code examples even when in simple mode for API playground
- Support "command \+ k" shortcut for search in web editor
- Codeblocks within callouts expand to fill the width of the callout area

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'Codeblocks'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'callouts'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'callout'?
</Update>

<Update label="February 2025">
Expand All @@ -108,15 +108,15 @@
mint upgrade
```

1. Delete your old mint.json file and push your changes
1. Delete your old `mint.json` file and push your changes

## CI Checks

Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

## .md support for LLMs

Check warning on line 117 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L117

Did you really mean 'LLMs'?

All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

Check warning on line 119 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L119

Did you really mean 'LLMs'?

## More Themes

Expand Down Expand Up @@ -144,7 +144,7 @@
- New UI with dedicated chat page & pre-filled prompts
- Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
- More robust knowledge for adding & editing components
- Improved mint.json file editing
- Improved `docs.json` file editing

## Partial Authentication

Expand Down Expand Up @@ -198,7 +198,7 @@
<Frame>
![llms.txt support](/images/changelog/llms.jpg)
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

Check warning on line 201 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L201

Did you really mean 'LLMs'?

## Localization

Expand Down Expand Up @@ -242,7 +242,7 @@

## Light mode code blocks

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

```json
"codeBlock": {
Expand Down Expand Up @@ -270,7 +270,7 @@
## Dashboard Improvements

- Added ability to change custom domain to be /docs directly through dashboard settings.
- Consolidated the login and signup pages to decrease friction and confusion.

Check warning on line 273 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L273

Did you really mean 'signup'?
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
- Added login with Google OAuth
- Added ability to add new deployment through dashboard settings.
Expand All @@ -284,7 +284,7 @@
- Don't allow search engines to crawl user-auth protected pages.
- Revalidate the cache when an org is deleted.
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.

Check warning on line 287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L287

Did you really mean 'autogenerated'?
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
- Properly show in-line code styling in conjunction with links.
Expand Down Expand Up @@ -317,7 +317,7 @@
<Frame>
![SEO Improvements](/images/changelog/seo-improvements.jpeg)
</Frame>
We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

Check warning on line 320 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L320

Did you really mean 'navbar'?

## Dashboard Improvements

Expand Down Expand Up @@ -351,7 +351,7 @@

## File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L354

Did you really mean 'proxied'?
`disableProxy` to disable this behavior and support request types like file
uploads.

Expand Down Expand Up @@ -384,7 +384,7 @@
</Frame>
For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or

Check warning on line 387 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L387

Did you really mean 'chatbot'?
on your existing documentation pages.

- [Read the blog announcement](https://mintlify.com/blog/widget)
Expand All @@ -409,17 +409,17 @@
<Update label="June 2024">
## Launch Week Highlights

- 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.
- 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.
- 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.
- Web Editor branching: create branches in our web editor without an IDE.
- 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.
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch!

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

<Update label="May 2024">
## Okta SSO

We now support sign-on via Okta SAML and OIDC.

Check warning on line 422 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L422

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -442,7 +442,7 @@
<Update label="March 2024">
## Mintlify MDX for VSCode

Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

Check warning on line 445 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L445

Did you really mean 'callouts'?
</Update>

<Update label="February 2024">
Expand All @@ -451,7 +451,7 @@
- Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
- Versioning with tabs fully supported
- Wildcard redirects now supported
- CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development

Check warning on line 454 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L454

Did you really mean 'frontmatter'?
</Update>

<Update label="January 2024">
Expand Down
47 changes: 47 additions & 0 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors:

Check warning on line 16 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L16

Did you really mean 'tooltips'?

```json
{
Expand Down Expand Up @@ -145,7 +145,7 @@

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

Check warning on line 148 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L148

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
Expand Down Expand Up @@ -250,12 +250,12 @@

### Structure

<ResponseField name="navbar" type="object">

Check warning on line 253 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L253

Did you really mean 'navbar'?
Navigation bar items.

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
Links to display in the navbar

Check warning on line 258 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L258

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
Expand Down Expand Up @@ -293,7 +293,7 @@

<Expandable title="Navigation">
<ResponseField name="global" type="object">
Global navigation elements that appear accross all pages and sections.

Check warning on line 296 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L296

Did you really mean 'accross'?

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Expand Down Expand Up @@ -527,7 +527,7 @@
Contextual menu for AI-optimized content and integrations.

<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot;" required>

Check warning on line 530 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L530

Did you really mean 'chatgpt'?

Check warning on line 530 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L530

Did you really mean 'claude'?
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.
- `view`: View the current page as Markdown in a new tab.
Expand All @@ -546,7 +546,7 @@

### API Configurations

<ResponseField name="api" type="object">

Check warning on line 549 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L549

Did you really mean 'api'?
API documentation and interactive playground settings.

<Expandable title="Api">
Expand Down Expand Up @@ -965,7 +965,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 968 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L968

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1008,7 +1008,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1011 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1011

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1017,8 +1017,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1020 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1020

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1021 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1021

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1139,7 +1139,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1142 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1142

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1182,7 +1182,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1185 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1185

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1191,8 +1191,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1194 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1194

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1195 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1195

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1277,10 +1277,10 @@
{
"dropdown": "Documentación",
"icon": "book",
"description": "Cómo usar el producto de Example Co.",

Check warning on line 1280 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1280

Did you really mean 'usar'?

Check warning on line 1280 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1280

Did you really mean 'producto'?
"pages": [
{
"group": "Comenzando",

Check warning on line 1283 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1283

Did you really mean 'Comenzando'?
"pages": ["es/index", "es/quickstart"]
},
{
Expand All @@ -1300,7 +1300,7 @@
{
"dropdown": "Changelog",
"icon": "history",
"description": "Actualizaciones y cambios",

Check warning on line 1303 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1303

Did you really mean 'Actualizaciones'?

Check warning on line 1303 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1303

Did you really mean 'cambios'?
"pages": ["es/changelog"]
}
]
Expand Down Expand Up @@ -1328,7 +1328,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1331 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1331

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1371,7 +1371,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1374 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1374

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1380,8 +1380,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1383 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1383

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1384 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1384

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand All @@ -1396,3 +1396,50 @@
```
</Tab>
</Tabs>

## Upgrading from `mint.json`

If your docs project uses the deprecated `mint.json` file, follow these steps to upgrade to `docs.json`.

<Steps>
<Step title="Install or update the CLI">
If you haven't installed the [CLI](/installation), install it now:

<CodeGroup>

```bash npm
npm i -g mint
```


```bash yarn
yarn global add mint
```


```bash pnpm
pnpm add -g mint
```

</CodeGroup>

If you already have the CLI installed, make sure it is up to date:

```bash
mint update
```

</Step>
<Step title="Create your docs.json file">
In your docs repository, run:

```bash
mint upgrade
```

This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
</Step>
</Steps>