Skip to content
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.

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

add tags in changelog #564

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
41 changes: 18 additions & 23 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
---
title: "Product Updates"
description: "New updates and improvements"
mode: "center"
---

<Update label="February 2025">
<Update label="February 2025" tags={["Configuration", "Feature", "Documentation"]}>
## New Configuration Schema `docs.json`

We've introduced a new `docs.json` schema as a replacement for `mint.json`, to support better multi-level versioning, easier visual comprehension, and more consistent terminology. For more information on what's changed, [check out our blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json).&#x20;



Upgrade from `mint.json` to `docs.json` with the following steps:

1. Make sure your CLI is the latest version
Expand All @@ -31,9 +28,9 @@

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 31 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L31

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.
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 33 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L33

Did you really mean 'LLMs'?

## More Themes

Expand All @@ -50,12 +47,12 @@
## Other improvements
- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
- [Dropdown component](/navigation/divisions#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if theres a parsing error and use AI to suggest fixes.
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if there's a parsing error and use AI to suggest fixes.


</Update>

<Update label="January 2025">
<Update label="January 2025" tags={["AI", "Authentication", "API", "Performance"]}>
## AI Assistant Improvements

* New UI with dedicated chat page & pre-filled prompts
Expand All @@ -72,7 +69,7 @@

## Revamped API Playground

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

* Easier detail expansion for an overview of a field

Expand All @@ -85,7 +82,7 @@
* Support for requiring authentication to access preview deployments
</Update>

<Update label="December 2024">
<Update label="December 2024" tags={["Authentication", "Feature"]}>
## Authentication

<Frame>
Expand All @@ -95,7 +92,7 @@
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">
<Update label="November 2024" tags={["AI", "Integration", "Editor", "Documentation"]}>
## AI Assistant

<Frame>
Expand Down Expand Up @@ -124,7 +121,7 @@
<img src="/images/changelog/llms.jpg" alt="llms.txt support" />
</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 124 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L124

Did you really mean 'LLMs'?

## Localization

Expand All @@ -137,7 +134,7 @@
* Authenticate users with OAuth, in addition to JWT or Shared Session tokens.
</Update>

<Update label="October 2024">
<Update label="October 2024" tags={["Components", "UI", "Feature", "Bug Fix"]}>
## Changelogs

Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users.
Expand Down Expand Up @@ -200,7 +197,7 @@

* 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 200 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L200

Did you really mean 'signup'?

* Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.

Expand All @@ -224,7 +221,7 @@

* 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 224 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L224

Did you really mean 'autogenerated'?

* Add in-line-style support for icons

Expand All @@ -235,7 +232,7 @@
* Maintain scroll position when you click the back button in a browser.
</Update>

<Update label="September 2024">
<Update label="September 2024" tags={["UI", "Components", "Performance", "SEO"]}>
## Custom Fonts

<Frame>
Expand Down Expand Up @@ -276,8 +273,6 @@

* Shipped GitLab connection UI.

* Fix incorrect analytics data.

* Add-on's can now be directly purchased through the dashboard.

## Bug Fixes
Expand All @@ -293,7 +288,7 @@
[Read the docs](/api-playground/troubleshooting)
</Update>

<Update label="August 2024">
<Update label="August 2024" tags={["API", "SEO", "Bug Fix"]}>
## OpenAPI Reference Pages

* Endpoints defined by OpenAPI that are complex and recursive are now 98%
Expand All @@ -305,7 +300,7 @@

## File Uploads in API Playground

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

Check warning on line 303 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L303

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

Expand All @@ -332,7 +327,7 @@
was used.
</Update>

<Update label="July 2024">
<Update label="July 2024" tags={["AI", "Feature", "API"]}>
## AI Widget

<Frame>
Expand All @@ -341,7 +336,7 @@

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 339 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L339

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

* [Read the blog announcement](https://mintlify.com/blog/widget)
Expand All @@ -363,12 +358,12 @@
product.
</Update>

<Update label="June 2024">
<Update label="June 2024" tags={["UI", "Search", "Editor", "API"]}>
## 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.

Check warning on line 366 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L366

Did you really mean 'searchbar'?

* Web Editor branching: create branches in our web editor without an IDE.

Expand All @@ -377,17 +372,17 @@
* 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">
<Update label="May 2024" tags={["Authentication", "API"]}>
## Okta SSO

Check warning on line 376 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L376

Did you really mean 'Okta'?

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

Check warning on line 378 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L378

Did you really mean 'Okta'?

## Mintlify REST API

Programmatically rigger updates to your documentation.
</Update>

<Update label="April 2024">
<Update label="April 2024" tags={["UI", "Feature"]}>
## Custom mode

Add a configuration to the metadata to remove all elements except for the top bar.
Expand All @@ -402,13 +397,13 @@
Check out our [Custom Mode docs](/page#custom-mode).
</Update>

<Update label="March 2024">
<Update label="March 2024" tags={["Editor", "Integration"]}>
## 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).

Check warning on line 403 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L403

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

<Update label="February 2024">
<Update label="February 2024" tags={["Feature", "Bug Fix"]}>
## Quality Improvements

* Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
Expand All @@ -417,10 +412,10 @@

* 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 415 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L415

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

<Update label="January 2024">
<Update label="January 2024" tags={["Feature", "Components", "AI"]}>
## 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.
Expand All @@ -430,4 +425,4 @@
* 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>
</Update>
Loading