diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 4013227d6..16f8400a2 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -4,58 +4,72 @@ description: "New updates and improvements" mode: "center" --- - + + ## .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 - + + ## 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 ## Authentication - + + Authentication screenshot - - 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. + + 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 @@ -327,61 +341,70 @@ We’ve overhauled the design and performance of the [API Playground](/api-playg + ## 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. + ## 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. + ## 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). - + * 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 + + 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). + ## 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 + + * 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 + ## 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. - + * 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. + \ No newline at end of file