diff --git a/changelog/overview.mdx b/changelog/overview.mdx index ede456eb..b44a9972 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -1,16 +1,13 @@ --- title: "Product Updates" description: "New updates and improvements" -mode: "center" --- - + ## 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). - - Upgrade from `mint.json` to `docs.json` with the following steps: 1. Make sure your CLI is the latest version @@ -33,7 +30,7 @@ mode: "center" ## .md support for 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. ## More Themes @@ -50,12 +47,12 @@ mode: "center" ## 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 there’s 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. - + ## AI Assistant Improvements * New UI with dedicated chat page & pre-filled prompts @@ -72,7 +69,7 @@ mode: "center" ## Revamped API Playground - We’ve 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 @@ -85,7 +82,7 @@ mode: "center" * Support for requiring authentication to access preview deployments - + ## Authentication @@ -95,7 +92,7 @@ mode: "center" 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. - + ## AI Assistant @@ -137,7 +134,7 @@ mode: "center" * Authenticate users with OAuth, in addition to JWT or Shared Session tokens. - + ## Changelogs Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users. @@ -235,7 +232,7 @@ mode: "center" * Maintain scroll position when you click the back button in a browser. - + ## Custom Fonts @@ -276,8 +273,6 @@ mode: "center" * Shipped GitLab connection UI. - * Fix incorrect analytics data. - * Add-on's can now be directly purchased through the dashboard. ## Bug Fixes @@ -293,7 +288,7 @@ mode: "center" [Read the docs](/api-playground/troubleshooting) - + ## OpenAPI Reference Pages * Endpoints defined by OpenAPI that are complex and recursive are now 98% @@ -332,7 +327,7 @@ mode: "center" was used. - + ## AI Widget @@ -363,7 +358,7 @@ mode: "center" product. - + ## 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. @@ -377,7 +372,7 @@ mode: "center" * 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. - + ## Okta SSO We now support sign-on via Okta SAML and OIDC. @@ -387,7 +382,7 @@ mode: "center" Programmatically rigger updates to your documentation. - + ## Custom mode Add a configuration to the metadata to remove all elements except for the top bar. @@ -402,13 +397,13 @@ mode: "center" Check out our [Custom Mode docs](/page#custom-mode). - + ## 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). - + ## Quality Improvements * Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments @@ -420,7 +415,7 @@ mode: "center" * CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development - + ## 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. @@ -430,4 +425,4 @@ mode: "center" * 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. - + \ No newline at end of file