Skip to content
Merged
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
145 changes: 84 additions & 61 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,72 @@
mode: "center"
---

<Update label = "February 2025">
<Update label="February 2025">
## .md support for LLMs

## docs.json replacing mint.json
Upgrades include better multi-level versioning, easier visual comprehension, and more consistent terminology.
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.

[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).
## docs.json replacing mint.json

## 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).
Upgrades include better multi-level versioning, easier visual comprehension, and more consistent terminology.

## More Themes
New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).
[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).

Now available:
- Maple
- Palm
## 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).

## More Themes

New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).

Now available:

* Maple

* Palm
</Update>

<Update label = "January 2025">
<Update label="January 2025">
## AI Assistant Improvements

* 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

## AI Assistant Improvements
- 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
* More robust knowledge for adding & editing components

## Partial Authentication
Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.
* Improved mint.json file editing

## Revamped API Playground
We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
## Partial Authentication

- Easier detail expansion for an overview of a field
- More intuitive nested design, e.g. adding or deleting items
- Faster response times
Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.

## Quality Improvements
- Support for requiring authentication to access preview deployments
## Revamped API Playground

We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:

* Easier detail expansion for an overview of a field

* More intuitive nested design, e.g. adding or deleting items

* Faster response times

## Quality Improvements

* Support for requiring authentication to access preview deployments
</Update>

<Update label="December 2024">
## Authentication
<Frame>

<Frame>
<img src="/images/changelog/authentication.png" alt="Authentication screenshot" />
</Frame>
Make docs private by setting up authentication via JWT, OAuth, or a universal password. With this privacy, you can create an internal knowledge base or prevent competitors from seeing your docs.
</Frame>

Make docs private by setting up authentication via JWT, OAuth, or a universal password. With this privacy, you can create an internal knowledge base or prevent competitors from seeing your docs.
</Update>


<Update label="November 2024">
## AI Assistant

Expand All @@ -71,7 +85,7 @@

## Web Editor

<Frame>

Check warning on line 88 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L88

Did you really mean 'LLMs'?
<img src="/images/changelog/webeditor.jpg" alt="Web Editor" />
</Frame>

Expand Down Expand Up @@ -147,7 +161,7 @@

You can now add more links to the standard footer. This upgrade
provides more consistency between landing pages and docs, or greater customization
if you want to spotlight specific pages like socials or status logs.

Check warning on line 164 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L164

Did you really mean 'signup'?

## Filter search based on the current user

Expand All @@ -171,7 +185,7 @@

## Bug Fixes

* Can now use leading slashes in navigation.

Check warning on line 188 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L188

Did you really mean 'autogenerated'?

* Can now edit CSS & JS files in the web editor.

Expand Down Expand Up @@ -252,7 +266,7 @@
* **Troubleshooting for API pages**: API pages could be complicated so we listed
common issues to help you sort them out quickly —
[Read the docs](/api-playground/troubleshooting)
</Update>

Check warning on line 269 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L269

Did you really mean 'proxied'?

<Update label="August 2024">
## OpenAPI Reference Pages
Expand Down Expand Up @@ -288,7 +302,7 @@

* We now raise more granular error messages for GitHub permissions when
interacting with the editor.

Check warning on line 305 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L305

Did you really mean 'chatbot'?
* Fixed bugs where the navigation would not properly expand when a direct link
was used.
</Update>
Expand Down Expand Up @@ -316,7 +330,7 @@
* [Read the blog announcement](https://mintlify.com/blog/pro-plan)

## API Playground Code Example Sync

Check warning on line 333 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L333

Did you really mean 'searchbar'?
When you browse API docs, the selected code example now syncs across your pages.

## Insights
Expand All @@ -325,63 +339,72 @@
into easy-to-digest reports with AI-powered suggestions on how to improve your
product.
</Update>

Check warning on line 342 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L342

Did you really mean 'Okta'?
<Update label="June 2024">

Check warning on line 343 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L343

Did you really mean 'Okta'?
## 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.

* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.

## 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.
* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar 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.
* 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.
</Update>

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

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

## Mintlify REST API
Programmatically rigger updates to your documentation.
## Mintlify REST API

Programmatically rigger updates to your documentation.
</Update>

Check warning on line 365 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L365

Did you really mean 'dcallouts'?

<Update label="April 2024">
## Custom mode

## Custom mode
Add a configuration to the metadata to remove all elements except for the top bar.
Example use cases:
* Create a custom global landing page setup with custom components
* Add full-screen videos or image galleries
* Embed custom iFrame demo elements to add intractability to your docs
Add a configuration to the metadata to remove all elements except for the top bar.
Example use cases:

Check out our [Custom Mode docs](/page#custom-mode).
</Update>
* Create a custom global landing page setup with custom components

* Add full-screen videos or image galleries

Check warning on line 375 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L375

Did you really mean 'frontmatter'?

* Embed custom iFrame demo elements to add intractability to your docs

Check out our [Custom Mode docs](/page#custom-mode).
</Update>

<Update label="March 2024">
## Mintlify MDX for VSCode
Call snippets of our pre-built components an dcallouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
## Mintlify MDX for VSCode

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

<Update label="February 2024">
## Quality Improvements

* 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

## Quality Improvements
* 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
* Wildcard redirects now supported

* CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development
</Update>

<Update label="January 2024">
## Launch Week Highlights

## Launch Week Highlights
* Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.
* Snippets V2: We now support fully reusable components and variables for snippets.
* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.
* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
* Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.

</Update>
* Snippets V2: We now support fully reusable components and variables for snippets.

* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.

* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
</Update>