From cf3a2d1ffe3de9572e9c5386f7f81f8b9d9f9ad5 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:08:32 +0000 Subject: [PATCH 1/4] Documentation edits made through Mintlify web editor --- changelog/overview.mdx | 238 +++++++++++++++++------------------------ 1 file changed, 101 insertions(+), 137 deletions(-) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index ede456eb..23e2f347 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -4,12 +4,31 @@ description: "New updates and improvements" mode: "center" --- - - ## New Configuration Schema `docs.json` + + +## MCP server generator +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.mdx) - 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). +## Improvements +- Tag changelog updates so end users can filter updates +- Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard +- Change deployment name from +## Bug fixes +- 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 + + + + + + ## 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: @@ -19,13 +38,13 @@ mode: "center" npm i mintlify@latest -g ``` - 2. In your docs repository, run + 1. In your docs repository, run ``` mintlify upgrade ``` - 3. Delete your old mint.json file and push your changes + 1. Delete your old mint.json file and push your changes ## CI Checks @@ -41,30 +60,24 @@ mode: "center" Now available: - * Maple - - * Palm - - * Willow + - Maple + - 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. - + - [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 + - 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 @@ -74,24 +87,21 @@ mode: "center" 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 + - 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 + - Support for requiring authentication to access preview deployments ## Authentication - Authentication screenshot + ![Authentication screenshot](/images/changelog/authentication.png) - 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. @@ -99,9 +109,8 @@ mode: "center" ## AI Assistant - AI Assistant + ![AI Assistant](/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 @@ -111,9 +120,8 @@ mode: "center" ## Web Editor - Web Editor + ![Web Editor](/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. Check out our [docs on getting started with Web Editor](/web-editor). @@ -121,9 +129,8 @@ mode: "center" ## /llms.txt support - llms.txt support + ![llms.txt support](/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 @@ -132,9 +139,8 @@ mode: "center" ### 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. + - 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. @@ -143,9 +149,8 @@ mode: "center" Launched a new [Update component](/content/components/update) to make it easier to display and report updates (like this one) to your users. - Changelog + ![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. @@ -181,9 +186,8 @@ mode: "center" ## Advanced Footer - Advanced Footer + ![Advanced Footer](/images/changelog/advanced-footer.gif) - 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. @@ -198,50 +202,34 @@ mode: "center" ## 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 login with Google OAuth - - * Added ability to add new deployment through dashboard settings. + - 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 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 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. + - 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 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. ## Custom Fonts - 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 @@ -251,9 +239,8 @@ mode: "center" ## Update Speed Performances - Performance Improvements + ![Performance Improvements](/images/changelog/performance-improvements.png) - For large projects (\~3,000 files), the download step for docs updates is 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. @@ -261,34 +248,27 @@ mode: "center" ## SEO improvements - SEO Improvements + ![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. - - * Fix incorrect analytics data. - - * Add-on's can now be directly purchased through the dashboard. + - 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. + - 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. + - 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) @@ -296,10 +276,9 @@ mode: "center" ## OpenAPI Reference Pages - * Endpoints defined by OpenAPI that are complex and recursive are now 98% + - Endpoints defined by OpenAPI that are complex and recursive are now 98% smaller. - - * We now show + - We now show [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/) in OpenAPI pages. @@ -309,7 +288,7 @@ mode: "center" `disableProxy` to disable this behavior and support request types like file uploads. - * [Learn more about API configurations](/settings/global#api-configurations) + - [Learn more about API configurations](/settings/global#api-configurations) ## Mobile SEO improvements @@ -323,12 +302,10 @@ mode: "center" ## Bug Fixes - * Fixed a bug for the Segment integration functionality. - - * We now raise more granular error messages for GitHub permissions when + - 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 + - Fixed bugs where the navigation would not properly expand when a direct link was used. @@ -336,21 +313,20 @@ mode: "center" ## AI Widget - 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. - * [Read the blog announcement](https://mintlify.com/blog/widget) + - [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) + - [Read the blog announcement](https://mintlify.com/blog/pro-plan) ## API Playground Code Example Sync @@ -366,15 +342,11 @@ mode: "center" ## 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. + - 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. @@ -393,11 +365,9 @@ mode: "center" 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 + - 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). @@ -411,23 +381,17 @@ mode: "center" ## 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 + - 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. - - * 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 From e1671771ef3c43c3baf4477dfcbdf0681e1619aa Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 21:10:22 +0000 Subject: [PATCH 2/4] Documentation edits made through Mintlify web editor --- changelog/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 23e2f347..bcb921e5 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -13,7 +13,7 @@ Check out [docs on getting started with MCP.](/advanced/mcp/quickstart.mdx) ## Improvements - Tag changelog updates so end users can filter updates - Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard -- Change deployment name from +- Change your deployment name directly in dashboard settings ## Bug fixes - Fixed icon style inconsistency for anchors without container From ce862987b2491a3476841aa6eec70c4522a778c3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:02:09 +0000 Subject: [PATCH 3/4] Documentation edits made through Mintlify web editor --- changelog/overview.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index bcb921e5..80af7baf 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -10,6 +10,9 @@ mode: "center" 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.mdx) +## mcpt: a registry for MCP servers +Discover 100+ MCP servers at [mcpt](https://www.mcpt.com). This directory includes both official servers and those from our own customer base. + ## Improvements - Tag changelog updates so end users can filter updates - Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard From 67763a30dbe5c4274543afbac005c85f0f395853 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:02:44 +0000 Subject: [PATCH 4/4] Documentation edits made through Mintlify web editor --- changelog/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/overview.mdx b/changelog/overview.mdx index 80af7baf..2ae8b999 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -11,7 +11,7 @@ Generate MCP servers so that AI applications can interact with your docs or APIs Check out [docs on getting started with MCP.](/advanced/mcp/quickstart.mdx) ## mcpt: a registry for MCP servers -Discover 100+ MCP servers at [mcpt](https://www.mcpt.com). This directory includes both official servers and those from our own customer base. +Discover 105+ MCP servers at [mcpt](https://www.mcpt.com). This directory includes both official servers and those from our own customer base. ## Improvements - Tag changelog updates so end users can filter updates