Changelog Update for September 15-22 #1228
+39
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,45 @@ | |
| noindex: true | ||
| --- | ||
|
|
||
| <Update label="September 15 - September 22" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "AI assistant enhancements, performance optimizations, web editor improvements, and API playground updates" }}> | ||
|
|
||
| ## AI assistant and search improvements | ||
|
|
||
| - Enhanced AI assistant response accuracy with improved context understanding and better source attribution | ||
| - Optimized search indexing for faster query responses and more relevant results | ||
| - Fixed assistant rate limiting issues that were affecting response times during peak usage | ||
| - Improved assistant analytics tracking for better insights into user interactions | ||
|
|
||
| ## Web editor and deployment enhancements | ||
|
|
||
| - Added support for real-time collaborative editing with conflict resolution improvements | ||
| - Enhanced branch switching performance in the web editor for faster navigation | ||
| - Fixed file upload functionality in the web editor for better asset management | ||
| - Improved preview deployment reliability with enhanced error handling and status reporting | ||
|
|
||
| ## API playground and documentation features | ||
|
|
||
| - Added support for additional HTTP methods in API playground testing | ||
| - Enhanced OpenAPI spec parsing with better error messages and validation | ||
| - Improved code example generation with more accurate syntax highlighting | ||
| - Fixed API playground authentication flow for OAuth and JWT configurations | ||
|
|
||
| ## Performance and reliability improvements | ||
|
|
||
| - Optimized page load times by reducing bundle sizes and improving caching strategies | ||
| - Enhanced CDN performance for faster asset delivery across global regions | ||
| - Fixed memory leaks in long-running sessions that were affecting editor performance | ||
| - Improved error logging and monitoring for faster issue resolution | ||
|
|
||
| ## Bug fixes and quality improvements | ||
|
|
||
| - Fixed navigation menu rendering issues on mobile devices | ||
| - Resolved table of contents anchor link behavior in nested page structures | ||
| - Fixed custom domain SSL certificate renewal process for improved reliability | ||
| - Enhanced accessibility features with better keyboard navigation and screen reader support | ||
|
|
||
| </Update> | ||
|
|
||
| <Update label="September 14 - September 19" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "GitLab integration enhancements, app router migration progress, authentication improvements, and bug fixes" }}> | ||
|
|
||
| ## GitLab integration enhancements | ||
|
|
@@ -20,11 +59,11 @@ | |
|
|
||
| ## Bug fixes and reliability | ||
|
|
||
| - Fixed app router socket update functionality for real-time features | ||
| - Fixed SVG path rendering issues in documentation | ||
| - Fixed keyboard navigation in search and chat functionality | ||
| - Fixed history status endpoint reliability | ||
| - Resolved middleware edge cases and onClick event handling issues | ||
|
|
||
| </Update> | ||
|
|
||
|
|
@@ -34,14 +73,14 @@ | |
|
|
||
| - **Major enhancement**: AI suggested pages on 404 pages, [when someone hits a dead link → AI agent reads the path → suggests semantically similar pages](https://x.com/mintlify/status/1966625627773059495) | ||
| - **Major release**: web search for assistant can now include external sources | ||
| _Note: Contact us to enable this feature for your site._ | ||
|
|
||
| ## Assistant and MCP | ||
|
|
||
| - Fixed a bug where the assistant would be incorrectly rate limited due to time window not sliding correctly | ||
| - Fixed a bug with assistant tool calling to properly handle empty `text` blocks | ||
| - Fixed a bug where MCP server name's concatenated with tool calls were sometimes exceeding the 60 character length MCP clients enforce | ||
| - Fixed a bug where the assistant menu would have a height several times larger than the viewport and scroll forever | ||
| - Fixed a bug where assistant spend values could display with greater than two decimal places in the dashboard | ||
|
|
||
| ## Web editor and deployments | ||
|
|
@@ -49,20 +88,20 @@ | |
| - Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes | ||
| - Fixed a bug where preview deployments wouldn't work for branches with `=` in the name | ||
| - Fixed a bug where long branch names would overflow modals on preview deployment creations | ||
| - Quality of life improvement where email query parameter will prefill the input on signup invitations | ||
|
Check warning on line 91 in changelog.mdx
|
||
| - Fixed a bug where copying a page from the context menu was not working on safari | ||
|
|
||
| ## API playground and navigation | ||
|
|
||
| - Multiple API playground response codes now display in a controlled styled select menu instead of the system default select menu when focused | ||
| - You can now use the [`expanded` field on navigation groups in your `docs.json` to make them be default open](https://mintlify.com/docs/navigation#default-expanded-state) | ||
|
|
||
| ## SEO and UI | ||
|
Check warning on line 99 in changelog.mdx
|
||
|
|
||
| - Fixed a bug where favicons were not showing up in search engines by serving them from the same URL as the documentation site itself for each respective site | ||
| - Fixed a bug where youtube embeds would flash in and out on load | ||
| - Fixed a bug where expanding the feedback menu to include written responses would cause layout shift with the table of contents | ||
| - Fixed a bug where text would leak above the topbar on the maple theme when a dismissed the notification banner | ||
| - Enhanced the Maple and Willow themes by adding login/logout buttons to the sidebar for easier access | ||
|
|
||
| ## Analytics and exports | ||
|
|
@@ -77,7 +116,7 @@ | |
| ## Major release: Enhanced feedback collection | ||
|
|
||
| - **Major improvement**: Readers can now give more detailed feedback after selecting *thumbs up/down*, including options and written comments. You can also collect feedback on code blocks and view all responses in your dashboard analytics. | ||
| _Note: Contact us to enable this feature for your site._ | ||
|
|
||
| ## Navigation and quality of life improvements | ||
|
|
||
|
|
@@ -93,16 +132,16 @@ | |
| - Fixed a bug where Google was indexing raw `*.md` files because they were missing a `x-robots-tag noindex` header | ||
| - Fixed a bug with OAuth on protected docs where it wouldn't redirect you back to your starting page once you completed the flow successfully | ||
| - Fixed a bug on previews of auth protected docs where you weren't able to see the entire navigation bar | ||
| - Bug fixes to how SVGs are handled with our new image CDN | ||
|
Check warning on line 135 in changelog.mdx
|
||
|
|
||
| ## Component and styling enhancements | ||
|
|
||
| - Added a new CSS selector for custom styles on `SidebarNavGroupDivider` | ||
| - New regression tests for MDX defined API pages that have security defined on them will ensure a greater degree of stability | ||
|
|
||
| ## Performance improvements | ||
|
|
||
| - Performance improvement by moving the KaTeX CSS from cdnjs to our own CDN on Cloudfront for reduced latency | ||
|
Check warning on line 144 in changelog.mdx
|
||
|
|
||
| </Update> | ||
|
|
||
|
|
@@ -111,18 +150,18 @@ | |
| ## Image handling improvements | ||
|
|
||
| - **Major improvement**: Images no longer cause layout shift by default, even when width and height attributes aren't specified—automatic sizing prevents content jumping during page loads | ||
| - All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage | ||
|
Check warning on line 153 in changelog.mdx
|
||
|
|
||
| ## Web editor and deployment enhancements | ||
|
|
||
| - Fixed branch creation workflow in web editor to correctly navigate to and stay on newly created branches | ||
| - Enhanced merge conflict dialog with proper escape functionality, no more page reloads required to dismiss conflicts | ||
| - Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing deployment times | ||
|
|
||
| ## Authentication and navigation improvements | ||
|
|
||
| - New support for authentication on custom subdirectories, if you serve docs at `https://yourdomain.com/docs`, authentication now works seamlessly | ||
| - Fixed sidebar display bug that incorrectly showed when only one link was configured | ||
| - Comprehensive mobile navigation overhaul: centered buttons with proper margin/padding, improved spacing in dropdown menus, removed unnecessary dividers and margins for empty sections, and fixed Maple theme gap/padding issues | ||
|
|
||
| ## Component and styling fixes | ||
|
|
@@ -134,7 +173,7 @@ | |
|
|
||
| - Enhanced logging system for update workflows enabling faster debugging and issue resolution | ||
| - Fixed GitHub rate limiting for customers with 10+ OpenAPI/AsyncAPI specs by switching from individual file fetching to repository cloning | ||
| - Improved assistant reliability with backup LLM support, enhanced rate limit error handling, and more robust search tool functionality | ||
|
Check warning on line 176 in changelog.mdx
|
||
|
|
||
| </Update> | ||
|
|
||
|
|
@@ -143,16 +182,16 @@ | |
| ## Performance and build optimizations | ||
|
|
||
| - MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages. | ||
| - Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved) | ||
| - Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend | ||
|
Check warning on line 186 in changelog.mdx
|
||
| - Reduced page size by eliminating duplicate `navigation` data in each page's `rsc` payload—performance gains most noticeable with high page counts or complex navigation structures | ||
| - More aggressive prefetching enables instant page loads more frequently | ||
|
|
||
| ## API playground and OpenAPI enhancements | ||
|
|
||
| - OpenAPI to MCP conversion moved to backend, enabling hosted MCP servers to contain tools (expect clearer documentation and config options soon) | ||
| - Added Ruby support to API playground | ||
| - We added a feature such that you can now [specify API pages using just your docs.json](/api-playground/openapi-setup#auto-populate-api-pages) without creating any new mdx files. | ||
| - Support for [`webhook` pages](/api-playground/openapi-setup#webhooks) in docs navigation from OpenAPI specs | ||
| - Optimized AI model context by removing anchor link specifications from markdown links when navigating to Anthropic, OpenAI, or other providers | ||
|
|
||
|
|
@@ -161,18 +200,18 @@ | |
| - File creation/renaming now saves changes when clicking away instead of requiring Enter key press | ||
| - Fixed branch navigation where changing URL to specific branch would redirect to last active branch instead of intended destination | ||
| - Properly URL encode branch titles containing `/` to prevent navigation breakage | ||
| - Fixed `Ctrl+K` link shortcut in monorepo dashboard Editor that was prepending docs repo path and creating broken links | ||
|
|
||
| ## Analytics and LLM integrations | ||
|
Check warning on line 205 in changelog.mdx
|
||
|
|
||
| - Custom `llms.txt` and `llms-full.txt` support—add to docs repo root to serve at `/llms.txt` and `/llms-full.txt` endpoints for LLM customization | ||
| - Added [Hightouch analytics integration](/integrations/analytics/hightouch#hightouch) | ||
| - Enhanced context menu analytics tracking (dashboard viewing coming soon) | ||
| - Added e2e tests for `llms.txt` and `llms-full.txt` to ensure correct serving | ||
|
|
||
| ## Component and styling enhancements | ||
|
|
||
| - Support for custom classnames in `h{1-4}` tags for applying custom heading styles | ||
| - Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode | ||
| - Added CSS selectors to [breadcrumbs](/navigation#breadcrumbs) for custom CSS targeting | ||
| - Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height | ||
|
|
@@ -182,10 +221,10 @@ | |
| ## Bug fixes and reliability | ||
|
|
||
| - Fixed PDF render issues with certain page titles by sanitizing characters that cause generation problems | ||
| - Resolved CLI error `Cannot convert undefined or null to object` when encountering empty OpenAPI JSON files | ||
| - Fixed custom `docs.json` open-graph metatags being overwritten by generated ones | ||
| - Fixed RSS feed button clicks when landing on anchor links by using origin + pathname for RSS links | ||
|
Check warning on line 226 in changelog.mdx
|
||
| - Improved CLI download speed by removing sourcemaps | ||
|
Check warning on line 227 in changelog.mdx
|
||
|
|
||
| ## Technical improvements | ||
|
|
||
|
|
@@ -200,40 +239,40 @@ | |
|
|
||
| - Group-level public access: make entire page groups public via `docs.json` so you don’t need `public: true` on each page ([learn more](https://mintlify.com/docs/authentication-personalization/authentication-setup#group-level)) | ||
| - Support [`logoutURL` in OAuth configuration](https://mintlify.com/docs/authentication-personalization/authentication-setup#implementation-3) to delete upstream cookies and complete sign-out | ||
| - On OAuth errors, users are redirected to your specified `logoutURL` to restart the auth flow | ||
| - Fixed a flash of a 500 error during OAuth/JWT flows before the callback | ||
| - Auto-strip `https://` from URLs in OAuth/JWT auth configuration to prevent misconfiguration | ||
|
Check warning on line 244 in changelog.mdx
|
||
|
|
||
| ## API playground enhancements | ||
|
|
||
| - New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs | ||
| - `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`) | ||
| - You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples | ||
| - [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools | ||
|
|
||
| ## Assistant updates | ||
|
|
||
| - Fixed an issue where the action menu (containing options like copy and thumbs up) for older messages disappeared when new ones streamed in | ||
| - Fixed accessibility of nested `/mcp/...` pages after the [hosted MCP servers release](https://mintlify.com/docs/ai/model-context-protocol#accessing-your-mcp-server) from last week | ||
|
|
||
| ## Performance and reliability | ||
|
|
||
| - All image and video assets present in your docs repo are now served at the appropriate path on your domain. For example, if you have `/assets/marketing/my-logo.png` in your repo, it will be available at `https://mydocsurl.extension/assets/marketing/my-logo.png`. | ||
| - Email field on login for the Mintlify dashboard now autofocuses so you can start typing immediately _(quality of life improvement)_ | ||
|
Check warning on line 261 in changelog.mdx
|
||
| - Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction) | ||
|
Check warning on line 262 in changelog.mdx
|
||
| - Added retry logic for PDF exports to improve reliability | ||
| - Fixed cookie consent popup reappearing after acceptance or dismissal—first selection is now respected | ||
| - Fixed copying a page to clipboard on Safari by specifying a MIME `type` in `navigator.write` | ||
|
|
||
| ## Technical improvements | ||
|
|
||
| - CLI bugfixes for windows and pnpm, plus CI tests to prevent regressions | ||
|
Check warning on line 269 in changelog.mdx
|
||
| - Improved error logging output—a quality of life upgrade for our engineering team when debugging | ||
| - Minor fixes to the broken-link CI action when `contentDirectory` files are missing | ||
| - Fixed a regression caused by the auth-protected preview fixes from last week where the active tab was not being set correctly in the navigation UI | ||
|
Check warning on line 272 in changelog.mdx
|
||
| - Fixed theme light background color not being applied to active tab icons | ||
| - Fixed an issue where changing the auth type in the dashboard would update and then flip back to the previously saved type—now the new selection persists after saving | ||
| - Internal DX improvements for enterprise customers with custom UI libraries—it's now easier for us to include your components and accommodate requests on shorter timelines | ||
| </Update> | ||
|
|
||
| <Update label="July 27 - August 2" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Authentication improvements, search enhancements, and assistant API" }}> | ||
|
|
@@ -242,11 +281,11 @@ | |
| - Local development improvements to auth, enabling faster development of auth features and bug fixes in this product area | ||
| - Preview deployments now available for auth-protected sites | ||
| - Fixed redirect behavior to properly return users to their original page after authentication | ||
| - Fixed logout button display for full authentication (previously only worked for partial authentication) | ||
|
|
||
| ## API playground enhancements | ||
|
|
||
| - Fixed `multipart/form-data` file upload functionality in the API playground | ||
| - Fixed anchor link behavior so clicking them updates the URL without scrolling to top of page | ||
| - Fixed anchor link issues in nested tabs | ||
|
|
||
|
|
@@ -258,15 +297,15 @@ | |
|
|
||
| ## Performance and reliability | ||
|
|
||
| - Made search feel more crisp and accurate by aborting debounced requests as you type | ||
| - Resource provisions for a new CDN - expect image asset and page load times to improve soon | ||
| - Fixed bugs for rendering complex Mermaid diagrams like GANTT charts | ||
| - Fixed CLI bugs on Windows to improve stability and added tests to prevent regression | ||
|
|
||
| ## Technical improvements | ||
|
|
||
| - Added OpenTelemetry for traces in NextJS application to improve time to first byte for customers | ||
| - Migrated from Octokit to GitHub API Client to improve latency in the web editor experience | ||
| - Fixed duplicate meta tags for OpenGraph | ||
| - Upgraded MongoDB from version 6 to 7 for improved performance and new features | ||
| </Update> | ||
|
|
@@ -274,16 +313,16 @@ | |
| <Update label="July 2025" tags={["New releases", "Improvements"]} rss={{ title: "July Product Updates", description: "Slack app integration, hosted MCP servers, Cursor integration, and performance improvements" }}> | ||
| ## Slack app | ||
|
|
||
| - Zero friction access: Bot responds to DMs, @mentions, and any question in your `#ask-ai` channel | ||
| - One-click setup: Install directly from your Mintlify dashboard in seconds | ||
| - Contextual answers: Searches your entire documentation to provide relevant, accurate responses | ||
| - Deflect support interruptions: Turn daily questions into instant, self-serve answers | ||
|
|
||
| Learn more in our [Slack app guide](/ai/slack-app). | ||
|
|
||
| ## Hosted MCP servers | ||
|
|
||
| Deploy hosted Model Context Protocol (MCP) servers directly through Mintlify to integrate with AI tool like Claude, Cursor, and others. Learn more in our [MCP guide](/ai/model-context-protocol). | ||
|
|
||
| Help users quickly connect your MCP server to Cursor or VS Code from any page in your docs via the contextual menu. See [Contextual menu](/ai/contextual-menu) for more information. | ||
|
|
||
|
|
@@ -296,7 +335,7 @@ | |
| <Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}> | ||
| ## AI assistant updates | ||
|
|
||
| - Improved accuracy through agentic RAG with tool calling | ||
| - Provides navigable links to referenced pages so that users can go directly to the source of answers | ||
| - Copy shortcut for code examples generated by assistant | ||
| - "Ask AI" shortcut on code blocks in documentation to generate explanations from the assistant | ||
|
|
@@ -304,10 +343,10 @@ | |
| Learn more in the [assistant docs](/guides/assistant). | ||
|
|
||
| ## Subscribable changelogs | ||
| - Automatically generate an RSS feed from changelog pages | ||
| - Integrate RSS-enabled updates with Slack, email, and other tools | ||
|
|
||
| Learn more in our new [Changelog guide](/guides/changelogs) | ||
|
|
||
| </Update> | ||
|
|
||
|
|
@@ -322,14 +361,14 @@ | |
| Learn more at [API playground docs.](/api-playground/) | ||
|
|
||
| ## `mint update` | ||
| Can now use `mint update` to update your CLI. | ||
| </Update> | ||
|
|
||
| <Update label="April 2025" tags={["New releases", "Improvements"]}> | ||
| ## Web Editor 3.0 | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| Overhauled usability in the WYSIWYG editor. | ||
|
|
||
|
|
@@ -338,21 +377,21 @@ | |
| - Search for file names using ⌘ \+ P shortcut | ||
| - Pages load 10x faster | ||
| - Faster load times when searching for a branch | ||
| - Page options tab to configure layout, title, & metadata for SEO | ||
| - Floating toolbar when you highlight text | ||
|
|
||
| **Additional fixes** | ||
|
|
||
| - Fixed top margin for changelog components | ||
| - Improved reliability of right click behavior | ||
| - After clicking publish, you’ll stay on the same page instead of being brought to an empty state | ||
| - Standardized colors in file icons | ||
| - Improved reliability after selecting new branches several times in a row | ||
| - Removed Diff mode | ||
| - More consistency when creating a new folder from the dropdown | ||
| - Fixed block quotes creating more block quotes when trying to deselect | ||
|
|
||
| ## AI Translations in beta | ||
|
|
||
| <Frame> | ||
|  | ||
|
|
@@ -387,10 +426,10 @@ | |
|
|
||
| - 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 | ||
| </Update> | ||
|
|
||
| <Update label="February 2025" tags={["New releases", "Improvements"]}> | ||
|
|
@@ -403,7 +442,7 @@ | |
|
|
||
| Upgrade from `mint.json` to `docs.json` with the following steps: | ||
|
|
||
| 1. Make sure your CLI is the latest version | ||
|
|
||
| ```bash | ||
| npm i mint@latest -g | ||
|
|
@@ -417,15 +456,15 @@ | |
|
|
||
| 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 | ||
|
|
||
| <Frame> | ||
|  | ||
|
|
@@ -442,24 +481,24 @@ | |
|
|
||
| - [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#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. | ||
| </Update> | ||
|
|
||
| <Update label="January 2025" tags={["Improvements"]}> | ||
| ## AI Assistant Improvements | ||
|
|
||
| - New UI with dedicated chat page & pre-filled prompts | ||
| - Stability improvements. For example, bug fixes of editing the wrong file or no files at all | ||
| - More robust knowledge for adding & editing components | ||
| - Improved `docs.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. | ||
|
|
||
| ## 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. For example, adding or deleting items | ||
|
|
@@ -480,27 +519,27 @@ | |
| </Update> | ||
|
|
||
| <Update label="November 2024"> | ||
| ## AI Writer | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the writer 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. | ||
|
Check warning on line 531 in changelog.mdx
|
||
|
|
||
| ## Web Editor | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| 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](/editor). | ||
|
|
||
| ## /llms.txt support | ||
|
|
||
| <Frame> | ||
|  | ||
|
|
@@ -509,23 +548,23 @@ | |
|
|
||
| ## 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 | ||
|
|
||
| - 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. | ||
| </Update> | ||
|
|
||
| <Update label="October 2024"> | ||
| ## Changelogs | ||
|
|
||
| Launched a new [Update component](/components/update) to make it easier to display and report updates (like this one) to your users. | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| ## 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. | ||
|
|
||
|
|
@@ -549,7 +588,7 @@ | |
|
|
||
| ## Light mode code blocks | ||
|
|
||
| Code blocks now have a light mode variant which can be enabled by adding the following to your `docs.json`: | ||
|
|
||
| ```json | ||
| "codeBlock": { | ||
|
|
@@ -557,7 +596,7 @@ | |
| } | ||
| ``` | ||
|
|
||
| ## Advanced Footer | ||
|
|
||
| <Frame> | ||
|  | ||
|
|
@@ -568,29 +607,29 @@ | |
|
|
||
| ## 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:[email protected]) 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 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. | ||
|
|
@@ -599,18 +638,18 @@ | |
| </Update> | ||
|
|
||
| <Update label="September 2024"> | ||
| ## Custom Fonts | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| 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](/components/cards#image-card). | ||
|
|
||
| ## Update Speed Performances | ||
|
|
||
| <Frame> | ||
|  | ||
|
|
@@ -619,10 +658,10 @@ | |
| ~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 | ||
|
Check warning on line 661 in changelog.mdx
|
||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| 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. | ||
|
|
||
|
|
@@ -630,75 +669,75 @@ | |
|
|
||
| - App router migration in the dashboard. | ||
| - Search analytics are now available in the dashboard. | ||
| - Delete an org functionality has been added to the dashboard. | ||
|
Check warning on line 672 in changelog.mdx
|
||
| - 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. | ||
|
|
||
| ## More | ||
|
|
||
| - **Troubleshooting for API pages**: API pages could be complicated so we listed | ||
|
Check warning on line 684 in changelog.mdx
|
||
| common issues to help you sort them out quickly — | ||
| [Read the docs](/api-playground/troubleshooting) | ||
| </Update> | ||
|
|
||
| <Update label="August 2024"> | ||
| ## 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#api-configurations) | ||
|
|
||
| ## Mobile SEO improvements | ||
|
Check warning on line 706 in changelog.mdx
|
||
|
|
||
| We've fixed the mobile layout of our docs so that they are more SEO-friendly - | ||
|
Check warning on line 708 in changelog.mdx
|
||
| 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. | ||
|
Check warning on line 714 in changelog.mdx
|
||
|
|
||
| ## 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. | ||
| </Update> | ||
|
|
||
| <Update label="July 2024"> | ||
| ## AI Widget | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| 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) | ||
|
|
||
| ## Pro Plan | ||
|
|
||
| We also updated our pricing plans for better customizability and scale. | ||
|
Check warning on line 740 in changelog.mdx
|
||
|
|
||
| - [Read the blog announcement](https://mintlify.com/blog/pro-plan) | ||
|
|
||
|
|
@@ -714,21 +753,21 @@ | |
| </Update> | ||
|
|
||
| <Update label="June 2024"> | ||
| ## Launch Week Highlights | ||
|
|
||
| - Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `docs.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. | ||
| - OpenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the `docs.json`. | ||
| </Update> | ||
|
|
||
| <Update label="May 2024"> | ||
| ## Okta SSO | ||
|
Check warning on line 766 in changelog.mdx
|
||
|
|
||
| We now support sign-on via Okta SAML and OIDC. | ||
|
Check warning on line 768 in changelog.mdx
|
||
|
|
||
| ## Mintlify REST API | ||
|
Check warning on line 770 in changelog.mdx
|
||
|
|
||
| Programmatically rigger updates to your documentation. | ||
| </Update> | ||
|
|
@@ -743,13 +782,13 @@ | |
| - Add full-screen videos or image galleries | ||
| - Embed custom iFrame demo elements to add intractability to your docs | ||
|
|
||
| Check out our [Custom Mode docs](pages#custom-mode). | ||
| </Update> | ||
|
|
||
| <Update label="March 2024"> | ||
| ## 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). | ||
| </Update> | ||
|
|
||
| <Update label="February 2024"> | ||
|
|
@@ -758,14 +797,14 @@ | |
| - 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 | ||
|
Check warning on line 800 in changelog.mdx
|
||
| </Update> | ||
|
|
||
| <Update label="January 2024"> | ||
| ## 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. | ||
| </Update> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Changelog Date Range Overlap
The new changelog entry for "September 15 - September 22" is placed before the "September 14 - September 19" entry. This creates a 5-day date range overlap (September 15-19) and breaks the expected chronological order and non-overlapping pattern of changelog updates, which could confuse readers about the timeline.