diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 5454d30a..2a6a183a 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -2,46 +2,97 @@ title: "Product Updates" description: "New updates and improvements" mode: "center" +showTags: true --- - + + +## WebSockets +Create WebSockets reference pages with AsyncAPI. Learn more in [WebSockets docs](/api-playground/websockets). + + + ## AI Translations in beta ![AI Translations graphic](/images/changelog/translations.png) -Translate all of your documentation with AI. [Learn more.](/navigation/localization) +Translate all of your documentation with AI. [See supported languages.](/navigation/localization) + + + ## Export docs to PDF in beta Export all of your documentation, a subdirectory, or a singe page as a PDF. + + + + +## LLM shortcuts via contextual menu + + ![LLM shortcuts via contextual menu](/images/changelog/llmshortcuts.jpeg) + +Allow users to input your docs into LLMs with a dropdown. [Set up the contextual menu in docs.json](/settings/global#param-contextual). + + + + +## More models for AI chat +Supported models include: +- Sonnet-3.7 +- Gemini 2.5 +- Llama 4 Maverick +- OpenAI GPT-4o +Configure your preferred model through the dashboard. - + + +## Quality improvements +- Support bullets in cards +- Support headings in components +- Support anchors in components + + + + +## Bug fixes +- Set max height for table of contents to ensure scrollability +- Webhooks grouped with endpoints instead of creating new "Webhook" grouping in API reference +- First click on the tab buttons no longer scrolls the tab to the top of the page +- Show invisible options for type dropdown in API playground +- Show configuration status only when not on subdirectory +- Fixed icon style inconsistency for anchors without container +- 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 + + + ## MCP server generator ![screenshot of MCP server generator](/images/changelog/mcpgenerator.png) Generate MCP servers so that AI applications can interact with your docs or APIs. Written content is automatically generated as an MCP server, and you can generate an MCP server from your OpenAPI spec with one click. Check out [docs on getting started with MCP.](/advanced/mcp/quickstart) + - ## Improvements + + ## Tailwind CSS support + [Tailwind CSS](/settings/custom-scripts#custom-css-and-js) now supported out of the box. + + + ## Quality improvements - Tag changelog updates so end users can filter updates - - Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard + - Sonnet-3.7 supported for AI Chat - Change your deployment name directly in dashboard settings - - ## Bug fixes - - - OG images fixed - - Fixed icon style inconsistency for anchors without container - - 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 + - Prompt to confirm changes before switching branches in web editor - + ## New configuration schema `docs.json` ![docs.json screenshot](/images/changelog/docsjson.png) @@ -62,63 +113,56 @@ Export all of your documentation, a subdirectory, or a singe page as a PDF. ``` mintlify upgrade ``` + - 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 - - 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 ![graphic with text "Themes v2"](/images/changelog/themes.png) - New [pre-built themes](/themes) to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global). - - Now available: - - - Maple + We've added more themes to choose from: + - Ash + - Breeze + - Evergreen + - Geyser - Palm - Willow - - ## 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 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 - - ## Partial Authentication - - Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system. + +## Web editor improvements +Includes bug fixes and quality of life improvements: +- Accordions no longer have pointer cursor on the non-clickable body of the accordion, just the trigger +- Fixed bug where clicking on a link in an accordion would not close the accordion +- Fixed bug where clicking on a link in a dropdown would not close the dropdown +- Fixed bug where clicking on a link in a tab would not close the tab +- Fixed bug where clicking on a link in a modal would not close the modal +- Fixed bug where clicking on a link in a sidebar would not close the sidebar +- Add dropdowns for props with union types +- Match image metadata editor to match new prop editor + + ## 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 - More intuitive nested design, e.g. adding or deleting items - Faster response times + ## Quality Improvements - Support for requiring authentication to access preview deployments - + ## Authentication @@ -127,293 +171,272 @@ Export all of your documentation, a subdirectory, or a singe page as a PDF. 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 - ![AI Assistant](/images/changelog/ai-assistant.jpg) + ![AI Assistant screenshot](/images/changelog/ai-assistant.jpg) You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the assistant will propose changes by generating a pull request. + + ## GitLab Integration Upgrade We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started. + + ## Web Editor - ![Web Editor](/images/changelog/webeditor.jpg) + ![Web Editor screenshot](/images/changelog/webeditor.jpg) - We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. +We’ve revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown. Check out our [docs on getting started with Web Editor](/web-editor). + + ## /llms.txt support - ![llms.txt support](/images/changelog/llms.jpg) + ![llms.txt screenshot](/images/changelog/llms.jpg) 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) + + ## Localization You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale. + - ### Quality Improvements + + ## Quality Improvements - Return chat & search results based on the current version that the user is reading - 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. - - - ![Changelog](/images/changelog/changelog.jpg) - + ## Code Line Highlighting You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas. - ```javascript Line Highlighting Example {1,3-5} - const greeting = "Hello, World!"; - function sayHello() { - console.log(greeting); - } - sayHello(); - ``` - ````md - ```javascript Line Highlighting Example {1,3-5} - const greeting = "Hello, World!"; - function sayHello() { - console.log(greeting); + ```js {1,3-4} + import { useState } from 'react' + + export default function Counter() { + const [count, setCount] = useState(0) + return ( + + ) } - sayHello(); ``` ```` + + ## Light mode code blocks Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`: - ```json - "codeBlock": { - "mode": "auto" + { + "lightCodeTheme": true } ``` + + ## Advanced Footer - - - ![Advanced Footer](/images/changelog/advanced-footer.gif) - - You can now add more links to the standard footer. This upgrade + We've added a new footer component that supports links, socials, and more. This provides more consistency between landing pages and docs, or greater customization if you want to spotlight specific pages like socials or status logs. + + ## Filter search based on the current user When personalization is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content. + + ## Custom Prompts for AI Chat You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts. + + ## 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. - - Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. + - Added ability to see deployment status in dashboard settings. + - Added ability to see deployment logs in dashboard settings. - Added login with Google OAuth - Added ability to add new deployment through dashboard settings. + + ## Bug Fixes - Can now use leading slashes in navigation. - - Can now edit CSS & JS files in the web editor. - - Fixed `suggestEdit` not showing up even when enabled. - - Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. - - 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. - - Add in-line-style support for icons + - Fixed bug where clicking on a link in a dropdown would not close the dropdown. + - Fixed bug where clicking on a link in a tab would not close the tab. + - Fixed bug where clicking on a link in a modal would not close the modal. + - Fixed bug where clicking on a link in a sidebar would not close the sidebar. + - Fixed bug where clicking on a link in an accordion would not close the accordion. + - Fixed bug where clicking on a link in a popover would not close the popover. + - Fixed bug where clicking on a link in a tooltip would not close the tooltip. - Fixed the pop-in of custom CSS in docs. - Properly show in-line code styling in conjunction with links. - Maintain scroll position when you click the back button in a browser. + - Codeblocks within callouts expand to fill the width of the callout area - + ## Custom Fonts ![Custom Fonts](/images/changelog/custom-fonts.jpeg) Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand. + + ## Images in Card components Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/content/components/cards#image-card). + + ## Update Speed Performances - - - ![Performance Improvements](/images/changelog/performance-improvements.png) - - For large projects (~3,000 files), the download step for docs updates is now + We've optimized the performance of updates. File downloads during updates are now ~440x faster - a 99.8% time reduction. Across the board, file downloads during updates are now ~5.5x faster - an 81.8% time reduction. + + ## SEO improvements - ![SEO Improvements](/images/changelog/seo-improvements.jpeg) + ![SEO improvements](/images/changelog/seo-improvements.jpeg) 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. + + ## Dashboard Improvements - App router migration in the dashboard. - - Search analytics are now available in the dashboard. - - Delete an org functionality has been added to the dashboard. - - Shipped GitLab connection UI. + - Added ability to see deployment status in dashboard settings. + - Added ability to see deployment logs in dashboard settings. - Fix incorrect analytics data. - Add-on's can now be directly purchased through the dashboard. + + ## Bug Fixes - Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. - Fix relative positioning of the AI widget. - - ## More - - - **Troubleshooting for API pages**: API pages could be complicated so we listed + - 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) - - - - ## OpenAPI Reference Pages - - - Endpoints defined by OpenAPI that are complex and recursive are now 98% - smaller. - - We now show - [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/) - in OpenAPI pages. - - ## File Uploads in API Playground - - By default, API playground requests are proxied by Mintlify. Now you can use - `disableProxy` to disable this behavior and support request types like file - uploads. - - [Learn more about API configurations](/settings/global#api-configurations) - - ## Mobile SEO improvements - - We've fixed the mobile layout of our docs so that they are more SEO-friendly - - including adding proper aria tags to elements. - - ## Support Form - - We added a more detailed support form to the Mintlify dashboard. You can now - submit a form to get in touch with us. - - ## Bug Fixes - - - Fixed a bug for the Segment integration functionality. - - We now raise more granular error messages for GitHub permissions when - interacting with the editor. - - Fixed bugs where the navigation would not properly expand when a direct link - was used. - + ## AI Widget ![AI Widget](/images/changelog/widget.png) - 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 - on your existing documentation pages. + + Add a chat widget to your docs. The widget comes with: + - Contextual responses based on your docs + - Support for code snippets + - Ability to reference specific sections - [Read the blog announcement](https://mintlify.com/blog/widget) + + ## Pro Plan We also updated our pricing plans for better customizability and scale. - [Read the blog announcement](https://mintlify.com/blog/pro-plan) + + ## API Playground Code Example Sync When you browse API docs, the selected code example now syncs across your pages. + This means you can select Python once and see Python examples everywhere. + + ## Insights Currently in beta, this feature summarizes common user questions and patterns - into easy-to-digest reports with AI-powered suggestions on how to improve your + from your docs. It helps you understand what users are looking for in your 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. - - 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. - - - + ## Okta SSO We now support sign-on via Okta SAML and OIDC. + + ## Mintlify REST API Programmatically rigger updates to your documentation. - + ## 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 + ```json + { + "mode": "custom" + } + ``` Check out our [Custom Mode docs](/page#custom-mode). - + ## 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). - + ## 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 - + ## 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. + - Mintlify MDX Engine: We've rebuilt our MDX engine to be more performant and extensible. You can now use MDX components in your docs without any additional configuration. - 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. + + + + ## Bug fixes + - Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. + - Fix relative positioning of the AI widget. \ No newline at end of file diff --git a/docs.json b/docs.json index 3142b96b..9d0853f9 100644 --- a/docs.json +++ b/docs.json @@ -390,5 +390,5 @@ "og:title": "Mintlify Docs", "og:description": "Mintlify is a documentation platform that helps you create, manage, and share documentation for your projects." } -} + } } diff --git a/images/changelog/advanced-footer.gif b/images/changelog/advanced-footer.gif deleted file mode 100644 index 39cc4469..00000000 Binary files a/images/changelog/advanced-footer.gif and /dev/null differ diff --git a/images/changelog/llmshortcuts.jpeg b/images/changelog/llmshortcuts.jpeg new file mode 100644 index 00000000..7cc6672f Binary files /dev/null and b/images/changelog/llmshortcuts.jpeg differ