diff --git a/changelog.mdx b/changelog.mdx index 3f1817baa..9f5b708cf 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,8 +5,35 @@ rss: true noindex: true --- - + + ## Web Editor + + The [editor](https://www.mintlify.com/docs/editor) has been redesigned for live collaboration, parsing, and stability. Additional improvements include: + + - **Agent panel**: Chat with the editor agent inline — attach files, view per-session diffs, leave feedback, and jump to the page the agent edited. + - **Add to Assistant**: Send highlighted content straight to the [Assistant](https://www.mintlify.com/docs/assistant) from the editor toolbar. + - **File tree**: Create folders, create unlisted pages, and rename items in the file tree. Add unlisted Markdown into the navigation tree, and open unlisted Markdown and media files directly from the tree. + + ## Improvements + + - **Workflows**: New **Add GitHub repositories** link in the Workflows repository dropdown makes it easier to connect additional repositories without leaving the page. The Workflow Runs tab now defaults to **All runs** when nothing currently needs review, and a **View all runs** button on the empty state clears active filters in one click. + - **Mintlify Agent**: The [Mintlify agent](https://www.mintlify.com/docs/agent/slack) can now be installed in your Slack workspace even without having a Mintlify-hosted deployment. Additionally, viewer-role users can now ask questions and get answers using read-only tools, and the agent now uses prior thread images and message reactions as additional context. + - **Schema graph callbacks**: API reference pages now render OpenAPI `callbacks` in the schema graph. + - **Danish language support** added. + ## Bug fixes + + - Restored the editor's agent history panel. + - Fixed live collaboration for hidden blocks in the editor. + - Fixed cases where the source editor would misparse content. + - Fixed `Cmd+B` so it toggles the nav sidebar from anywhere in the dashboard. + - Fixed keyboard navigation and default open state for the agent panel. + - Fixed thumbs-up/down feedback being double-counted in the analytics dashboard. + - The chat CSV export now always includes the **Query category** column. + - Fixed an issue where root pages could be incorrectly stamped as public. + + + ## Expanded MCP content access Authenticated [MCP servers](/ai/model-context-protocol) now return more of your content to authorized users. Authenticated users can search public pages plus any pages they have permission to access based on their user groups, instead of being limited to public pages only. [Client credentials](/ai/model-context-protocol#client-credentials) return all public pages and authenticated pages that aren't restricted to specific groups. @@ -30,11 +57,9 @@ noindex: true - TLS certificate provisioning for [custom domains](/customize/custom-domain#automatic-tls-provisioning) is now handled directly by Mintlify. - GitLab-connected deployments can now revalidate their Git source from the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page by clicking the **Active** badge, useful when branch options or configuration appear stale. - The [feedback dashboard](/optimize/feedback) detailed feedback view now only shows submissions that include written comments, making qualitative feedback easier to scan. - - - + ## Workflows Workflows have been rebuilt with a new [dashboard experience](https://dashboard.mintlify.com/products/workflows?tab=workflows). @@ -54,7 +79,7 @@ noindex: true The classic editor sunsets in May 2026. ## Agent score - + [Agent score](http://mintlify.com/score) evaluates how agent-ready your site is. It is a free tool built on the open source [AFDocs spec](https://afdocs.dev) with additional checks based on Mintlify's research and best practices. ## Mintlify MCP @@ -66,7 +91,7 @@ noindex: true ## Agent connections Ask the agent in [Slack](/agent/slack) to set up any third-party integration that it should use as context. Prompt the agent to connect to a service like GitHub, Jira, Notion, Google Drive, Confluence, or any other service that you use. - + The agent uses [Composio](https://docs.composio.dev/toolkits) to support a broad catalog of third-party services, including issue trackers, knowledge bases, CRMs, and developer tools. See the [Composio toolkits catalog](https://docs.composio.dev/toolkits) for the full list of supported services. ## Section-level search boost @@ -74,7 +99,7 @@ noindex: true Search indexing now supports section-level boosts and page-level boosts, letting you promote specific content so it ranks higher for relevant queries. See the [search boost](/optimize/search-boost) documentation for more details. ## Improvements - + - Control whether OpenAPI-generated reference pages are included in your [Markdown export](/ai/llmstxt) and `llms-full.txt` - Search improvements: matched query terms highlighted in search results, search indexes content inside alt text, tag-based search filters are case-insensitive, and snippets no duplicate page titles. - Banner components support more types and per-user dismissibility. @@ -96,11 +121,9 @@ noindex: true - Fixed search results not finding bare queries like `search`. - Fixed self-serve deployment errors in the dashboard. - Fixed a workflow card toggle that could blank the dashboard page. - - - + ## Preview Deployment API A public API for generating preview deployments is now available. Use it to trigger previews from your own tooling—useful when your Git workflow doesn't map cleanly to standard branch-based preview triggers. See [Trigger preview deployment](/api/preview/trigger) for more details. @@ -140,11 +163,9 @@ noindex: true - Fixed symlink handling for skill files stored outside the content directory. - Fixed the Luma integration table of contents position. - Fixed deployment URLs not including the page href for direct links. - - - + ## Visibility component The new [`Visibility`](/components/visibility) component lets you show different content to human readers and AI agents on the same page. Wrap content in `` to display it only on the web version of a page or `` to include it only in [Markdown output](/ai/markdown-export) consumed by AI tools. Useful for tailoring instructions, examples, or formatting to each audience without maintaining separate pages. @@ -175,6 +196,7 @@ noindex: true - Custom `skill.md` files in your repository are now detected correctly during deployment. ## Deprecations + - File-based workflows are deprecated. Create workflows from the dashboard instead. Existing workflows from files continue to work, but new workflows must be created in the dashboard. ## Bug fixes @@ -187,15 +209,13 @@ noindex: true - Fixed the `mint analytics feedback` CLI command sending incorrect feedback type values. - Fixed a shadow artifact on number stepper buttons. - Fixed client-side navigation for related links. - - - + ## CLI analytics The [`mint analytics`](/cli/analytics) command lets you view traffic, search queries, user feedback, and assistant conversations from the terminal for better integration with agents. - + Use subcommands to explore specific data: - `mint analytics stats` — views, visitors, searches, feedback, and assistant usage for a date range @@ -221,7 +241,7 @@ noindex: true ## Client credentials for authenticated MCP [Client credentials](/ai/model-context-protocol#client-credentials) are now available for authenticated MCP servers. Use client credentials to connect programmatically without a browser-based login—ideal for server-side integrations, CI/CD pipelines, and automated workflows. Create and manage credentials from the MCP server page in your dashboard. - + ## Improvements - The [`mint new`](/cli/commands#mint-new) command now supports creating projects from pre-defined templates with the `--template` flag. @@ -248,12 +268,10 @@ noindex: true - Fixed an issue where switching branches could leave the editor in an inconsistent state. - Fixed API response example generation failing for certain OpenAPI schema types. - Fixed pages marked as hidden still appearing in the sitemap. - - - - ## get_page MCP tool + + ## get\_page MCP tool [MCP servers](/ai/model-context-protocol) that Mintlify generates now include a `get_page` tool that lets AI agents fetch full page content by path. Agents can retrieve complete documentation pages for deeper context beyond search results. @@ -287,11 +305,9 @@ noindex: true - Fixed [workflow](/workflows) automerge toggle not properly disabling when set to off. - Fixed API playground including optional object fields with required children in generated request bodies. - Fixed keyboard activation for the feedback analytics table selection checkbox. - - - + ## Linear integration Connect your Linear workspace from the agent settings page to give the agent access to your Linear issues. The agent can reference issues and comments as context when generating documentation updates or you can delegate issues to the agent to directly in your Linear workspace. @@ -299,7 +315,7 @@ noindex: true ## Notion integration Connect your Notion workspace from the agent settings page to give the [agent](/agent) read access to your Notion content. The agent can reference Notion pages as context when generating documentation updates. - + ## Offline export Package your entire documentation site into a self-contained zip archive with the [`mint export`](/deploy/export) CLI command. Share the zip so your users can view your docs in their browser without an internet connection or a Mintlify account. @@ -349,11 +365,9 @@ noindex: true - Fixed navigation item badge wrapping. - Fixed API key being erased during prefill examples. - Fixed linked code snippets in cards not being clickable. - - - + ## Authenticated MCP route A new authenticated route is available for [MCP](/ai/model-context-protocol) servers, enabling secure search over documentation sites with authentication enabled. @@ -395,11 +409,9 @@ noindex: true - Fixed nested block elements inside lists. - Fixed code block tooltip appearing for Prompt and Mermaid components. - Fixed hidden page children not appearing in decorated navigation. - - - + ## Workflow templates Create [workflows](/workflows) faster with pre-built templates in the [dashboard](https://dashboard.mintlify.com/products/workflows). Choose from templates for changelog generation, API docs sync, feature documentation drafts, broken link detection, SEO audits, and more. Templates include optimized prompts and trigger configurations to get you started quickly. @@ -442,11 +454,9 @@ noindex: true - Fixed recursive workflow runs - Fixed agent from re-creating a PR when prompted for follow up changes - Fixed agent session errors for multi-lingual sessions - - - + ## Auto-generate documentation from public repositories [Auto-generate a complete documentation site](https://mintlify.com/explore) from any public GitHub repository. Replace `github.com` with `mintlify.com` in any public repository URL to instantly preview generated documentation. If you are the repository owner, claim the documentation site to add it to your Mintlify organization and customize it. @@ -481,11 +491,9 @@ noindex: true - Fixed branch names with underscores not working in the editor. - Fixed link border colors in callout components. - Fixed mobile zoom behavior for input fields. - - - + ## Workflows Automate documentation tasks with [workflows](/workflows). Set up scheduled or event-triggered automations that run the agent to update your documentation. @@ -517,11 +525,9 @@ noindex: true - Fixed frontmatter parsing in the editor. - Fixed table tooltip positioning. - Fixed dark/light image rendering without Frame wrapper. - - - + ## `assistant.md` and `agent.md` support Use `.mintlify/Assistant.md` and `.mintlify/AGENTS.md` files in your repository to customize the agent and assistant behaviors. See [Customize assistant behavior](/assistant/customize) and [Customize agent behavior](/agent/customize) for more information. @@ -542,11 +548,9 @@ noindex: true - Fixed logout timeout issues. - Fixed accordion ID deduplication to prevent duplicate anchor links. - Improved SVG sanitization for better security. - - - + ## Prompt component Use the [prompt](/components/prompt) component to display copyable prompts. Designed for sharing AI prompts and supports opening prompts directly in Cursor. @@ -576,11 +580,9 @@ noindex: true ## Feedback email capture The [feedback](optimize/feedback) form now includes an optional email field so users can provide contact information when submitting feedback. - - - + ## Self-serve SSO configuration Enterprise customers can now configure SAML SSO (Okta or Microsoft Entra) directly from the dashboard, including just-in-time (JIT) provisioning, provider switching, and connection removal. @@ -603,11 +605,9 @@ noindex: true - Renaming files via the configuration sheet in the editor now properly saves changes. - MDX parsing errors, like an unclosed `` tag, now update dynamically as you fix them instead of persisting incorrectly across reloads. - Drag-and-drop handles in the editor now align correctly with different content types like headings or paragraphs with consistent sizing and better hit areas. - - - + ## Skills installation simplified Install [skill.md files](/ai/skillmd) using just a documentation URL. No path to the `skill.md` file needed. @@ -626,7 +626,7 @@ noindex: true - What-you-see-is-what-you-get title and description editing for Cards, Accordions, and Steps components - Hide and unhide pages from your navigation - Local image support in live preview - - Code block triggering with ``` + - Code block triggering with - More precise drag handle selection - Stability improvements @@ -656,11 +656,9 @@ noindex: true - Fixed an issue where page "last modified" dates updated incorrectly during global config changes. - Fixed authentication issues affecting index pages from properly rendering. - GitHub status is now properly surfaced during onboarding if GitHub is down. - - - + ## `skill.md` auto-generation Documentation sites now auto-generate a `skill.md` file based on your API references, guides, and features to give AI agents a comprehensive skills file with context on how to help people use your product. `skill.md` replaces the `install.md` approach with more structured capabilities and wider adoption. If you have a custom `skills.md` file at the root of your documentation repository, it replaces the auto-generated version. See [skill.md](/ai/skillmd) for more information. @@ -678,14 +676,13 @@ noindex: true - Combined authentication, partial authentication, and personalization into a single authentication experience. See [Authentication setup](/deploy/authentication-setup) for more information. - Hidden pages now automatically receive `noindex` meta tags for better SEO control. - Added markdown support for image captions. - - - + ## `install.md` auto-generation + Documentation sites now auto-generate an `install.md` file that aggregates installation-related pages like quickstarts, getting started, installation, and setup guides for AI agents. If you have a custom `install.md` file in your documentation repository, it takes priority over the auto-generated version. - + ## Web editor improvements - **Live preview**: See real-time changes as you edit your documentation in the web editor. Live previews show your site exactly as it appears when published, without creating a preview deployment. @@ -710,10 +707,9 @@ noindex: true - Fixed images not displaying on initial load after uploading in the editor. - Fixed code styling within card links. - Fixed `.md` files incorrectly overwriting `.mdx` files. - - + ## Implicit snippets Snippets now work without explicit configuration. Previously, you needed to define snippets in a specific `/snippets` directory. Now, you can import any file as a snippet from anywhere in your docs for more flexible content reuse. See [Reusable snippets](/create/reusable-snippets) for more information. @@ -732,10 +728,9 @@ noindex: true - **Mermaid controls**: Interactive controls for [Mermaid diagrams](/components/mermaid-diagrams) to navigate large diagrams. - **URL parameters for search and assistant**: Open pages with the search modal prefilled with `?search=` or the assistant with `?assistant=`. User query parameters for direct linking and sharing knowledge. - **Profile name editing**: Users can now edit their first and last name in profile settings. - - + ## Web editor improvements The [web editor](/editor/index) now has a more intuitive interface and new capabilities. @@ -770,10 +765,9 @@ noindex: true - Fixed links in assistant opening in new windows instead of the same window. - Fixed Markdown link rendering in assistant responses. - Fixed header slug character handling for special characters. - - + ## Agent improvements - Added support for reading [custom instructions](/agent/customize) from an `AGENTS.md` file. @@ -804,12 +798,11 @@ noindex: true - Added support for Polish, Uzbek, and Hebrew languages. - UI elements in the API playground, including "Try it" and "Send" buttons, are now localized across all supported languages. - - + ## Agent suggestions - + The agent can now monitor Git repositories and suggest documentation updates. When user-facing code changes are detected, suggestions appear in the agent panel. Suggestions include the relevant pull request and a list of proposed documentation updates. Add suggestions as context for the agent to create pull requests or dismiss them. ## Q&A bot in Slack @@ -841,32 +834,28 @@ noindex: true - Fixed loading states and date range values for analytics page. - Folders in the web editor now properly maintain their open/closed state when other folders are opened or closed. - Fixed long API page titles overflowing instead of wrapping. - - + ## Preview widget Preview deployments now include an interactive widget that displays all changed files in the deployment. The widget appears as a floating button in the bottom-right corner and provides: - - One-click navigation to changed pages. - - Searchable list of all changed files with status badges (added, modified, removed). + - One-click navigation to changed pages. + - Searchable list of all changed files with status badges (added, modified, removed). The widget is automatically enabled on all preview deployments and helps reviewers quickly navigate to modified content. - - + ## Last modified dates You can now display "last modified" timestamps on all pages in your documentation. Enable this feature by setting the [`timestamp`](/organize/settings-seo#metadata) flag in your `docs.json` settings. When enabled, each page will automatically show when it was last updated, helping readers understand how current the content is. - - - + ## Web editor improvements - Fixed image uploading from visual mode in the editor. Now images upload with correct paths and improved path resolution handles absolute and relative paths. @@ -887,19 +876,17 @@ noindex: true - Fixed hash handling for URLs and table of contents to properly highlight the active page when accessing the root path with an index page. - Added ability to disable 404 page recommendations via configuration. - Fixed a bug in the API playground where boolean `false` and numeric `0` values in query parameters would be filtered out and not appear in the generated API request. - - + ## Assistant query bucketing [Assistant insights](https://dashboard.mintlify.com/products/assistant) now automatically groups similar queries together into question categories, which makes it easier to identify patterns in what your users are asking about. - - Click a category to see all conversations in the category and drill down into individual conversations where you can see user queries, assistant responses, and sources cited. + Click a category to see all conversations in the category and drill down into individual conversations where you can see user queries, assistant responses, and sources cited. - + ## .mintignore support - Added `.mintignore` file support to exclude specific files and directories from being processed and published to your documentation site. @@ -907,17 +894,15 @@ noindex: true - Excluded files don't appear in published docs, aren't indexed for search, and aren't accessible to visitors. Learn more in the [.mintignore documentation](/organize/mintignore). - - + ## Vale version upgrade - Upgraded backend dependencies to use Vale version 3.11.2-r5, bringing native MDX support to the Vale CI check feature. - - + ## API playground improvements - Fixed issue where response section would disappear when switching between endpoints with different response codes. The playground now properly resets to the first available response code when navigating to a new endpoint. @@ -935,10 +920,9 @@ noindex: true ## CLI improvements - Added error message for users running `mint dev` on Node.js versions below 20.17. Users are guided to upgrade to an LTS version. - - + ## New features - **Badge component**: New Badge component for displaying status indicators, labels, and tags @@ -996,13 +980,12 @@ noindex: true - Fixed outline blinking on image zoom modal open/close - External links now properly open in new tabs - Fixed dashboard design inconsistencies and improved spacing - - + ## Assistant improvements - - **Starter questions for assistant are here! You can add your own within the dashboard at [Assistant --> Settings](https://dashboard.mintlify.com/mintlify/mintlify/products/assistant/settings)** + - **Starter questions for assistant are here! You can add your own within the dashboard at [Assistant --\> Settings](https://dashboard.mintlify.com/mintlify/mintlify/products/assistant/settings)** - Assistant insights quality has been improved with default spam protection for abusive keywords and JSON queries. ## API playground improvements @@ -1034,10 +1017,9 @@ noindex: true - Removed x-overflow in Palm theme that was cutting off text in the API playground. - Increased content font-size to improve compatibility with browser reader modes. - Fixed Google login button styling for better visual consistency. - - + ## Insights improvements - Improved insights page with fixed date selectors for "today" and "yesterday" @@ -1078,11 +1060,10 @@ noindex: true - Fixed page header text overflow with `break-all` styling - Removed full width constraint for page size options - Fixed button size for accept organization invitations - - Fixed keyboard shortcut display showing "Ctrl+I" without plus sign on non-macOS computers - + - Fixed keyboard shortcut display showing "Ctrl\+I" without plus sign on non-macOS computers - + ## Assistant and AI improvements - Upgraded assistant prompt for better accuracy and context-aware responses @@ -1120,13 +1101,12 @@ noindex: true - Fixed OG image display to show division name for index pages - Fixed icon paths to include `BASE_PATH` for relative paths - Fixed assistant background blur removal for better performance - - + ## Assistant and Agent AI features - - Added list_pull_requests and list_commits tools for agent such that it can document a date range of PRs or multiple PRs at once + - Added list\_pull\_requests and list\_commits tools for agent such that it can document a date range of PRs or multiple PRs at once - Upgraded agent and assistant to Claude Sonnet 4.5 - Improved assistant search to query docs in parallel for faster assistant responses - Fixed conversation length counting to exclude tool calls @@ -1165,7 +1145,7 @@ noindex: true - Fixed referrer tracking to use domain instead of full URL - Fixed images always becoming MDX block elements (kept inline images inline) - Removed comments in raw markdown pages such that you can use TODO comments without them leaking to users - - Fixed directory reading support for read_external_files + - Fixed directory reading support for read\_external\_files ## Component and styling @@ -1174,7 +1154,7 @@ noindex: true - Changed 404 page copy to be more clear - + ## New features - **Products navigation**: Organize documentation for multiple products with the product switcher navigation @@ -1215,7 +1195,7 @@ noindex: true - Improved PR publish state management in web editor - + ## Language support expansion - Added support for Romanian and Czech languages in the documentation interface @@ -1239,7 +1219,7 @@ noindex: true - Enhanced database schema updates for better user management - + ## Web editor and dashboard login improvements - Continued app router migration for the web editor, removing blockers and improving performance @@ -1259,7 +1239,7 @@ noindex: true - Fixed keyboard navigation in search and chat functionality - + ## Major releases - **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) @@ -1285,7 +1265,7 @@ noindex: true ## 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) + - 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 @@ -1301,7 +1281,7 @@ noindex: true - Assistant analytics exports are now executed in the background and sent via email for a more reliable experience - + ## 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.\ @@ -1333,7 +1313,7 @@ noindex: true - Performance improvement by moving the KaTeX CSS from cdnjs to our own CDN on Cloudfront for reduced latency - + ## 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 @@ -1359,11 +1339,11 @@ noindex: true ## Technical improvements and reliability - 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 + - 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 - + ## 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. @@ -1408,7 +1388,7 @@ noindex: true - 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 + - Fixed RSS feed button clicks when landing on anchor links by using origin \+ pathname for RSS links - Improved CLI download speed by removing sourcemaps ## Technical improvements @@ -1418,7 +1398,7 @@ noindex: true - Comprehensive testing coverage for new features and edge cases - + ## Authentication improvements - 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)) @@ -1432,7 +1412,7 @@ noindex: true - 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 + - [`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 @@ -1459,7 +1439,7 @@ noindex: true - 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 - + ## Authentication improvements - Local development improvements to auth, enabling faster development of auth features and bug fixes in this product area @@ -1495,7 +1475,7 @@ noindex: true - Upgraded MongoDB from version 6 to 7 for improved performance and new features - + ## Slack app - Zero friction access: Bot responds to DMs, @mentions, and any question in your `#ask-ai` channel @@ -1517,7 +1497,7 @@ noindex: true - Added more customization options including focus mode, expandable code blocks, dark and light mode responsiveness, language dropdown menu, line numbering, and icons - + ## AI assistant updates - Improved accuracy through agentic RAG with tool calling @@ -1550,17 +1530,18 @@ noindex: true Can now use `mint update` to update your CLI. - + ## Web Editor 3.0 ![Webeditor3 Jpe](/images/webeditor3.jpeg) + Overhauled usability in the WYSIWYG editor. **Major improvements** - - Search for filenames using ⌘ + P shortcut + - Search for filenames 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 @@ -1582,6 +1563,7 @@ noindex: true ![AI Translations graphic](/images/changelog/translations.png) + Translate all of your documentation with AI. ## Export docs to PDF in beta @@ -1593,12 +1575,13 @@ noindex: true Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](customize/react-components) - + ## 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.](/ai/model-context-protocol) ## Improvements @@ -1613,16 +1596,17 @@ noindex: true - 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 + - Support "command \+ k" shortcut for search in web editor - Codeblocks within callouts expand to fill the width of the callout area - + ## New configuration schema `docs.json` ![docs.json screenshot](/images/changelog/docsjson.png) + 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: @@ -1654,6 +1638,7 @@ noindex: true ![graphic with text "Themes v2"](/images/changelog/themes.png) + New [pre-built themes](customize/themes) to modify the look & feel of your docs. Configure via your [docs.json file](organize/settings). Now available: @@ -1700,6 +1685,7 @@ noindex: true ![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. @@ -1709,6 +1695,7 @@ noindex: true ![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 writer will propose changes by generating a pull request. ## GitLab Integration Upgrade @@ -1720,6 +1707,7 @@ noindex: true ![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](/editor). @@ -1729,6 +1717,7 @@ noindex: true ![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 @@ -1749,11 +1738,12 @@ noindex: true ![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,4,5} + ```javascript Line Highlighting Example highlight={1,3-5} const greeting = "Hello, World!"; function sayHello() { console.log(greeting); @@ -1786,6 +1776,7 @@ noindex: true ![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. ## Filter search based on the current user @@ -1826,6 +1817,7 @@ noindex: true ![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 @@ -1837,6 +1829,7 @@ noindex: true ![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. ## SEO improvements @@ -1844,6 +1837,7 @@ noindex: true ![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 @@ -1898,6 +1892,7 @@ noindex: true ![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) diff --git a/docs.json b/docs.json index 2072f693a..095adf842 100644 --- a/docs.json +++ b/docs.json @@ -8,7 +8,10 @@ "light": "#26BD6C", "dark": "#166E3F" }, - "favicon": "/favicon.ico", + "favicon": { + "light": "/favicon.ico", + "dark": "/favicon.ico" + }, "icons": { "library": "lucide" }, diff --git a/es/changelog.mdx b/es/changelog.mdx index 2a114e513..ebb09ec98 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -5,6 +5,36 @@ rss: true noindex: true --- + + +
+ ## Configuración del editor para IA y publicación +
+ + El editor web ahora tiene un menú **Settings** dedicado con dos niveles de configuración: + + - **Tu configuración** está vinculada a tu cuenta y define cómo la IA del editor te asiste en tus ediciones. + - **Configuración de publicación** se establece por deployment por un administrador y define cómo se generan y combinan los commits y las pull requests. + + Consulta [Configuración del editor para IA y publicación](/es/editor/settings) para ver la referencia completa. + +
+ ## Nuevas funcionalidades +
+ + - **Instrucciones de IA**: añade orientación persistente que el editor envía a la IA en cada acción **Edit with AI** y sesión del agente. Úsalo para fijar la voz, la terminología, las preferencias de componentes o las reglas de formato y no tener que repetirlas en cada prompt. + - **Instrucciones de mensajes de commit**: guían a la IA cuando genera mensajes de commit al publicar — útil para ajustarte a Conventional Commits, prefijos de ticket o límites de longitud más estrictos para el asunto. + - **Instrucciones de pull request**: estandariza los títulos y descripciones de pull requests generados por la IA cada vez que el editor abre una pull request, incluidos los flujos **Create pull request** y **Merge and publish**. + +
+ ## Mejoras +
+ + - **Pull requests en borrador por defecto**: los administradores pueden configurar el editor para abrir cada nueva pull request como borrador, de modo que los revisores vean una señal clara de "aún no está lista" hasta que la marques como lista para revisión. + - **Método de merge por defecto**: elige **Merge**, **Squash** o **Rebase** como predeterminado para **Merge and publish**. Ajústalo a las reglas de protección de rama de tu proveedor de Git para evitar merges fallidos desde el editor. + + +
diff --git a/fr/changelog.mdx b/fr/changelog.mdx index 32e721955..c532d2d43 100644 --- a/fr/changelog.mdx +++ b/fr/changelog.mdx @@ -5,6 +5,36 @@ rss: true noindex: true --- + + +
+ ## Paramètres de l'éditeur pour l'IA et la publication +
+ + L'éditeur web dispose désormais d'un menu **Settings** dédié avec deux niveaux de configuration : + + - **Vos paramètres** sont liés à votre compte et déterminent comment l'IA de l'éditeur vous assiste lors de vos modifications. + - **Paramètres de publication** sont configurés par déploiement par un administrateur et déterminent comment les commits et les pull requests sont générés et fusionnés. + + Consultez [Paramètres de l'éditeur pour l'IA et la publication](/fr/editor/settings) pour la référence complète. + +
+ ## Nouvelles fonctionnalités +
+ + - **Instructions d'IA** : ajoutez des consignes persistantes que l'éditeur envoie à l'IA à chaque action **Edit with AI** et session de l'agent. Utilisez-les pour fixer le ton, la terminologie, les préférences de composants ou les règles de mise en forme et éviter de les répéter dans chaque prompt. + - **Instructions pour les messages de commit** : guident l'IA lorsqu'elle génère des messages de commit à la publication — utile pour respecter Conventional Commits, des préfixes de ticket ou une longueur de sujet plus stricte. + - **Instructions pour les pull requests** : standardisez les titres et descriptions de pull requests générés par l'IA à chaque fois que l'éditeur ouvre une pull request, y compris depuis les flux **Create pull request** et **Merge and publish**. + +
+ ## Améliorations +
+ + - **Pull requests en brouillon par défaut** : les administrateurs peuvent configurer l'éditeur pour ouvrir chaque nouvelle pull request en brouillon, afin que les relecteurs voient un signal clair de "pas encore prêt" jusqu'à ce que vous la marquiez prête à être examinée. + - **Méthode de fusion par défaut** : choisissez **Merge**, **Squash** ou **Rebase** comme méthode par défaut pour **Merge and publish**. Alignez-la sur les règles de protection de branche de votre fournisseur Git pour éviter les fusions échouées depuis l'éditeur. + + +
diff --git a/zh.json b/zh.json index 0c3a366f9..4785c6315 100644 --- a/zh.json +++ b/zh.json @@ -72,7 +72,8 @@ "zh/editor/live-preview", "zh/editor/collaborate", "zh/editor/publish", - "zh/editor/keyboard-shortcuts" + "zh/editor/keyboard-shortcuts", + "zh/editor/settings" ] }, "zh/create/text", diff --git a/zh/changelog.mdx b/zh/changelog.mdx index decf73016..43581b05d 100644 --- a/zh/changelog.mdx +++ b/zh/changelog.mdx @@ -5,6 +5,36 @@ rss: true noindex: true --- + + +
+ ## 用于 AI 与发布的编辑器设置 +
+ + Web 编辑器现在提供独立的 **Settings** 菜单，包含两层配置： + + - **个人设置**绑定到你的账号，决定编辑器的 AI 在你编辑时如何提供协助。 + - **发布设置**由管理员按部署进行配置，决定提交和 pull request 的生成与合并方式。 + + 详见 [用于 AI 与发布的编辑器设置](/zh/editor/settings)。 + +
+ ## 新功能 +
+ + - **AI 指令**：添加持续生效的指令，编辑器会在每次 **Edit with AI** 操作和 agent 会话中将其发送给 AI。可用于固定语气、术语、组件偏好或格式规则，避免在每个 prompt 中重复说明。 + - **提交信息指令**：在发布时引导 AI 生成提交信息——适合匹配 Conventional Commits、工单前缀或更严格的标题长度规范。 + - **Pull request 指令**：标准化编辑器在打开 pull request（包括 **Create pull request** 与 **Merge and publish** 流程）时由 AI 生成的标题和描述。 + +
+ ## 改进 +
+ + - **默认以草稿形式创建 pull request**：管理员可以将编辑器配置为以草稿方式打开每个新建的 pull request，让审阅者在你将其标记为可审阅前看到清晰的"尚未就绪"信号。 + - **默认合并方式**：为 **Merge and publish** 选择默认使用 **Merge**、**Squash** 或 **Rebase**。请与你的 Git 提供商分支保护规则保持一致，避免从编辑器合并失败。 + + +
diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx new file mode 100644 index 000000000..67386e1a6 --- /dev/null +++ b/zh/editor/settings.mdx @@ -0,0 +1,144 @@ +--- +title: "用于 AI 与发布的编辑器设置" +description: "为 Mintlify Web 编辑器配置 AI 指令、提交和 pull request 指引、草稿 pull request 以及默认合并方式。" +keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "提交", "草稿", "合并"] +--- + +Web 编辑器有两层设置： + +- **个人设置**仅对你生效，控制编辑器的 AI 在你编辑时如何提供协助。 +- **发布设置**对部署中的所有人生效，决定变更在被提交并转换为 pull request 时如何处理。 + +你可以在编辑器的 **Settings** 菜单中配置这两项。 + +
+ ## AI 指令 +
+ +AI 指令是编辑器随你的请求一起发送给 AI 的持续生效指令。用它来固定你不想在每次提示中都重复的风格和语气规则，例如语气、术语或格式约定。 + +你的指令适用于： + +- 对选中文本的 **Edit with AI** 操作，如改写、扩写或修正。 +- 从编辑器中启动的 **agent 会话**。 + +指令的作用范围是你的用户账号，因此每位团队成员维护各自的指令。 + +
+ ### 何时使用 AI 指令 +
+ +当你发现自己在提示中反复给出相同的指引时，就应该添加 AI 指令，例如： + +- 强制使用第二人称或句首大写式的标题。 +- 优先使用特定的产品名称或术语。 +- 禁用营销用语或填充性短语。 +- 要求使用特定组件，例如始终使用 `` 表示提示。 + +保持指令简短而具体。AI 会在每次请求时遵循它们，模糊或相互矛盾的规则会降低效果。 + +
+ ### 配置 AI 指令 +
+ +1. 打开编辑器，点击工具栏中的头像。 +2. 选择 **Settings**。 +3. 在 **AI instructions** 字段中输入希望 AI 遵循的指令。 +4. 保存更改。 + +示例： + +```text +- Use second person ("you") and active voice. +- Use sentence case for all headings. +- Refer to the product as "Acme" — never "Acme Inc." or "the platform". +- Wrap notes and warnings in or components. +- Do not add introductory filler like "In this guide" or "Let's explore". +``` + +将该字段留空以移除你的指令。 + +
+ ## 发布设置 +
+ +发布设置按部署进行配置，对所有从编辑器发布的人都生效。它们控制 pull request 和提交的生成、打开和合并方式。 + +你需要拥有 Mintlify 部署的管理员权限才能更改发布设置。 + +
+ ### 提交信息指令 +
+ +提交信息指令用于在发布时引导 AI 生成提交信息。每当你在发布时未自行填写提交信息，编辑器都会使用这些指令。 + +使用提交信息指令以匹配仓库中的现有约定，例如： + +- Conventional Commits（`docs(editor): ...`）。 +- 必需的工单或 issue 前缀。 +- 比默认 72 个字符更严格的标题长度上限。 + +示例： + +```text +Follow Conventional Commits. Use the "docs" type and an "editor" scope +for content changes (for example, "docs(editor): clarify quickstart steps"). +Keep the subject under 60 characters. +``` + +如果你的仓库对提交信息强制使用正则表达式校验，编辑器在生成后仍会按该正则进行验证。 + +
+ ### Pull request 指令 +
+ +Pull request 指令用于在 AI 生成 pull request 标题和描述时进行引导。每当编辑器代你打开 pull request 时都会应用，包括 **Create pull request** 和 **Merge and publish** 流程。 + +使用 pull request 指令来标准化审阅者看到的内容，例如： + +- 必需的小节，如 **Summary** 和 **Changes**。 +- 链接到跟踪系统的描述模板。 +- 对标题的语气或长度要求。 + +示例： + +```text +Title: imperative mood, under 70 characters, no trailing period. +Description: include a "## Summary" section (one sentence) and a +"## Changes" section as a bulleted list. Link any referenced page +using its relative path. +``` + +
+ ### 默认以草稿形式创建 pull request +
+ +开启该选项后，编辑器会以草稿状态打开每个新的 pull request。在将草稿 pull request 标记为可审阅之前，无法将其合并。该功能在以下场景中很有用： + +- 你的团队要求在 pull request 开放审批前先进行一次人工审阅。 +- 你希望分享预览 URL，但不希望传递"已准备好合并"的信号。 + +你仍然可以在 Git 提供商中将 pull request 标记为可审阅。 + +
+ ### 默认合并方式 +
+ +选择在你点击 **Merge and publish** 时编辑器使用的合并方式： + +- **Merge**：创建一个合并提交，保留分支的完整历史。 +- **Squash**：将分支上的所有提交合并为部署分支上的单个提交。 +- **Rebase**：将分支上的每个提交逐个重放到部署分支，不产生合并提交。 + +所选方式将作为默认值。如果你通过 API 或 Git 提供商的界面显式传入合并方式，那种方式将优先生效。 + + + 请让默认合并方式与 Git 提供商的分支保护设置一致。如果你的部署分支只允许 squash 合并，请将默认值设为 **Squash**，以避免从编辑器合并失败。 + + + + +- [发布](/zh/editor/publish) +- [配置](/zh/editor/configurations)