Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Get assistant conversations"
description: "Retrieve AI assistant conversation history including queries, responses, cited sources, and categories."
description: "Retrieve The Mintie Assistant conversation history including queries, responses, cited sources, and categories."

Check warning on line 3 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L3

Did you really mean 'Mintie'?
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant
keywords: ["analytics", "assistant", "conversations", "export", "AI"]
---

## Usage

Use this endpoint to export AI assistant conversation history from your documentation. Each conversation includes the user query, assistant response, sources cited, and query category.
Use this endpoint to export The Mintie Assistant conversation history from your documentation. Each conversation includes the user query, assistant response, sources cited, and query category.

Paginate through results using the `cursor` parameter returned in the response. Continue fetching while `hasMore` is `true`.

Expand All @@ -21,4 +21,4 @@
- **query**: The user's question
- **response**: The assistant's answer
- **sources**: Pages referenced in the response, with title and URL
- **queryCategory**: Classification of the query type (if available)

Check warning on line 24 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L24

Did you really mean 'queryCategory'?
2 changes: 1 addition & 1 deletion api/assistant/create-assistant-message-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Create assistant message"
description: "Send messages to the AI assistant and receive streaming responses using AI SDK v5 or later with the useChat hook."
description: "Send messages to The Mintie Assistant and receive streaming responses using AI SDK v5 or later with the useChat hook."

Check warning on line 3 in api/assistant/create-assistant-message-v2.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message-v2.mdx#L3

Did you really mean 'Mintie'?
openapi: /discovery-openapi.json POST /v2/assistant/{domain}/message
keywords:
[
Expand Down
2 changes: 1 addition & 1 deletion api/assistant/create-assistant-message.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Create assistant message (v1)"
description: "Deprecated. Send messages to the AI assistant using AI SDK v4. Use v2 endpoint for AI SDK v5 or later."
description: "Deprecated. Send messages to The Mintie Assistant using AI SDK v4. Use v2 endpoint for AI SDK v5 or later."

Check warning on line 3 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L3

Did you really mean 'Mintie'?
openapi: /discovery-openapi.json POST /v1/assistant/{domain}/message
tag: "Deprecated"
keywords: [ "assistant message", "embed", "chat", "integrate", "ai sdk v4" ]
Expand Down
6 changes: 3 additions & 3 deletions api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Introduction"
description: "Trigger updates, embed AI assistant, export analytics, and more"
description: "Trigger updates, embed The Mintie Assistant, export analytics, and more"

Check warning on line 3 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L3

Did you really mean 'Mintie'?
keywords: ["REST API", "endpoints", "API keys"]
---

The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

Check warning on line 7 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L7

Spell out 'REST', if it's unfamiliar to the audience.

## Endpoints

Expand All @@ -16,13 +16,13 @@
- [Generate assistant message](/api/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing.
- [Search documentation](/api/assistant/search): Search through your documentation.
- [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation.
- [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history.
- [Get assistant conversations](/api/analytics/assistant-conversations): Export The Mintie Assistant conversation history.

Check warning on line 19 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L19

Did you really mean 'Mintie'?

### Common use cases

- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status).
- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger).
- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search).
- **Custom integrations**: Embed The Mintie Assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search).

Check warning on line 25 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L25

Did you really mean 'Mintie'?
- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Get all agent jobs](/api/agent/get-all-jobs).
- **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api/analytics/feedback) and [Get assistant conversations](/api/analytics/assistant-conversations).

Expand Down
8 changes: 4 additions & 4 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

The assistant now also builds context from the page a user is on and indexes entire OpenAPI specifications.

## Default Vale configuration updates

Check warning on line 22 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L22

'Default Vale configuration updates' should use sentence-style capitalization.

The default [Vale configuration](/deploy/ci#configuration) now parses MDX as MD to avoid fragility with JSX. Previously, Vale returned false positive errors on any JSX inside of MDX components. Now, Vale parses MDX as MD to avoid these errors with tokenIgnores and blockIgnores for MDX and JSX elements that Vale should skip.

Check warning on line 24 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L24

Use 'md' instead of 'MD'.

Check warning on line 24 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L24

Use 'md' instead of 'MD'.

## Improvements

Expand Down Expand Up @@ -92,7 +92,7 @@

## Improvements

- New search functionality in the web editor makes it easier to find and navigate to files across your documentation.

Check warning on line 95 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L95

Use 'capability' or 'feature' instead of 'functionality'.
- Drag to add table rows and columns directly in the editor for faster table creation and modification.
- The API playground now supports audio response examples, making it easier to document audio-related API endpoints.

Expand Down Expand Up @@ -123,7 +123,7 @@

The [contextual menu](/ai/contextual-menu) now includes an option to add a copyable command to install your docs MCP server.

## `root` in groups

Check warning on line 126 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L126

'in groups' should use sentence-style capitalization.

Navigation groups now support a [`root`](/organize/navigation#root-page) property to set a landing page for the group. Clicking the group header navigates to the root page instead of expanding the group.

Expand All @@ -141,7 +141,7 @@

<Update label="February 6, 2026" tags={["New releases", "Improvements"]} rss={{ title: "Self-serve SSO, viewer role, human/AI traffic toggle, and slash command redesign" }}>

## Self-serve SSO configuration

Check warning on line 144 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L144

'Self-serve SSO configuration' should use sentence-style capitalization.

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.

Expand Down Expand Up @@ -210,7 +210,7 @@
- Fixed conflicts when multiple Mermaid diagrams appeared on the same page.
- Fixed a rendering loop that could cause performance issues with the Tabs component.
- Fixed the password reset button not working.
- The AI assistant no longer appears when printing pages.
- The Mintie Assistant no longer appears when printing pages.

Check warning on line 213 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L213

Did you really mean 'Mintie'?
- Fixed the cursor being invisible in dark mode.
- Fixed a bug that could strip style attributes in MDX.
- Fixed an issue where page "last modified" dates updated incorrectly during global config changes.
Expand All @@ -221,7 +221,7 @@

<Update label="January 23, 2026" tags={["New releases", "Improvements"]} rss={{ title: "skills.md, audit logs, and markdown export" }}>

## `skill.md` auto-generation

Check warning on line 224 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L224

'auto-generation' should use sentence-style capitalization.

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.

Expand All @@ -231,7 +231,7 @@

## Markdown export for agents

Documentation pages now serve raw markdown when the `Accept: text/markdown` header is sent, which enables better AI agent consumption of content.

Check warning on line 234 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L234

In general, use active voice instead of passive voice ('is sent').

## Improvements

Expand All @@ -243,7 +243,7 @@

<Update label="January 16, 2026" tags={["New releases", "Improvements"]} rss={{ title: "install.md, live preview in the web editor, and more" }}>

## `install.md` auto-generation

Check warning on line 246 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L246

'auto-generation' should use sentence-style capitalization.
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
Expand All @@ -253,7 +253,7 @@

## Branch search for Git integrations

Added branch search functionality for GitHub and GitLab integrations so that it is easier to find and switch between deployment branches in the Git settings of your dashboard.

Check warning on line 256 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L256

Use 'capability' or 'feature' instead of 'functionality'.

## `mintlify validate` CLI command

Expand Down Expand Up @@ -316,7 +316,7 @@
You can now [customize your Slack bot](/ai/slack-bot) directly from the dashboard.

- **Choose a reply channel**: Select which channel the bot automatically replies to all messages in. The default is `#ask-ai`.
- **Customize the bot's appearance**: Change the bot's avatar and name from your dashboard.

Check warning on line 319 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L319

Did you really mean 'bot's'?

Check warning on line 319 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L319

Did you really mean 'bot's'?

## Mobile navigation improvements

Expand Down Expand Up @@ -351,7 +351,7 @@
- Updated [publishing workflow](/editor/publish) to support one-click publishing or creating pull requests.
- Working in the web editor no longer requires you to sign in with GitHub.

## Onboarding improvements

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L354

Use 'onboarding' instead of 'Onboarding'.

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L354

'Onboarding improvements' should use sentence-style capitalization.

- Choose between a Mintlify-hosted documentation repository or using your own repository while signing up.
- Create a documentation site without connecting a GitHub account.
Expand All @@ -370,7 +370,7 @@
<Update label="December 12, 2025" tags={["New releases", "Improvements"]} rss={{ title: "Agent suggestions and Q&A bots" }}>
## 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.

Check warning on line 373 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L373

In general, use active voice instead of passive voice ('are detected').

## Q&A bots in Slack and Discord

Expand All @@ -386,7 +386,7 @@

- **Insights** renamed to **Analytics** in the dashboard.
- Added ability to delete a deployment from the dashboard.
- The `Tooltip` component has been redesigned with improved styling and now supports an optional `headline` prop for adding a title to your tooltips.

Check warning on line 389 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L389

In general, use active voice instead of passive voice ('been redesigned').
- The `mint a11y` command now supports `--skip-contrast` and `--skip-alt-text` flags, allowing you to run specific accessibility checks in your CI/CD pipeline. Use `--skip-contrast` to check only for missing alt text, or `--skip-alt-text` to check only color contrast ratios.

## Bug fixes
Expand All @@ -395,11 +395,11 @@
- Fixed heading levels 5 and 6 rendering in the web editor.
- Fixed schema page examples display in API reference pages.
- Fixed image upload paths in monorepo setups.
- Fixed an issue where the incorrect request payload value was being selected first in the API playground.

Check warning on line 398 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L398

In general, use active voice instead of passive voice ('being selected').
- Removed file extensions from default image titles when uploading.
- Fixed double underline styling on banner links.
- 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.

Check warning on line 402 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L402

In general, use active voice instead of passive voice ('are opened').
- Fixed long API page titles overflowing instead of wrapping.

</Update>
Expand All @@ -421,7 +421,7 @@

You can now display "last modified" timestamps on all pages in your documentation. Enable this feature by setting the [`timestamp`](/organize/settings#param-timestamp) 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.

Check warning on line 424 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L424

Avoid using 'will'.

</Update>

Expand All @@ -437,8 +437,8 @@

## Assistant improvements

- Fixed assistant submission to prevent empty messages from being sent.

Check warning on line 440 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L440

In general, use active voice instead of passive voice ('being sent').
- Fixed accidental message submission during IME composition (for languages like Japanese, Chinese, Korean).

Check warning on line 441 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L441

Spell out 'IME', if it's unfamiliar to the audience.
- Better behavior when adding code snippets to assistant.

## Bug fixes and reliability
Expand All @@ -446,7 +446,7 @@
- Fixed handling of complex Mermaid diagrams.
- 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.

Check warning on line 449 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L449

In general, use active voice instead of passive voice ('be filtered').

</Update>

Expand All @@ -459,10 +459,10 @@

</Update>

<Update label="December 1, 2025" tags={["New releases"]} rss={{ title: ".mintignore support", description: "Exclude files and directories from your published documentation" }}>

Check warning on line 462 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L462

'.mintignore support' should use sentence-style capitalization.
## .mintignore support

- Added `.mintignore` file support to exclude specific files and directories from being processed and published to your documentation site.

Check warning on line 465 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L465

In general, use active voice instead of passive voice ('being processed').
- Uses the same pattern syntax as `.gitignore` for familiar configuration.
- Excluded files don't appear in published docs, aren't indexed for search, and aren't accessible to visitors.

Expand All @@ -483,7 +483,7 @@
- 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.
- Fixed double "Authorization" header display in HTTP Basic authentication schemes. The authentication section now shows a cleaner interface with proper field labels and descriptions.
- Improved handling of `oneOf` schemas in nested objects and arrays. Complex API schemas with multiple type options now render correctly as dropdowns instead of tabs in appropriate contexts.
- Fixed missing path parameters that were defined at the endpoint level in OpenAPI specs. Parameters specified above individual operations are now properly included in both the main page and playground.

Check warning on line 486 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L486

In general, use active voice instead of passive voice ('were defined').

Check warning on line 486 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L486

Use 'preceding' instead of 'above'.
- Enhanced response example generation to include all required properties, even when examples only specify some fields. This ensures response examples are complete and accurate.
- Fixed missing prefill examples in object arrays. Array items with example data now properly populate in the playground with correct indexing.
- Improved description padding and spacing throughout the API playground for better readability and visual consistency.
Expand All @@ -494,7 +494,7 @@

## 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.

Check warning on line 497 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L497

In general, use active voice instead of passive voice ('are guided').

</Update>

Expand All @@ -513,14 +513,14 @@
- Security inputs defined at the operation level in OpenAPI specs now properly override top-level security definitions
- Fixed issue where header inputs marked as security parameters were incorrectly included in generated code examples
- Improved handling of `deepObject` style parameters in API field displays
- Better error messages when invalid URLs are provided in API configurations

Check warning on line 516 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L516

In general, use active voice instead of passive voice ('are provided').
- Improved UI for API playground with better spacing, layout, and loading

## Navigation and UI enhancements

- Tab hover indicators now have improved styling for better visual feedback
- Long words now wrap properly to prevent horizontal scrolling
- Step component now handles cases where no step title is provided

Check warning on line 523 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L523

In general, use active voice instead of passive voice ('is provided').
- Logo section spacing improved with better padding
- Fixed heading IDs to properly handle question marks and special characters for anchor links
- Icon component now accepts `className` prop for custom styling
Expand All @@ -535,7 +535,7 @@

## Component and styling enhancements

- Images can now be zoomed with improved overlay styling for both light and dark modes

Check warning on line 538 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L538

In general, use active voice instead of passive voice ('be zoomed').
- Fixed keyboard shortcut styles inside callouts for dark mode
- Improved OG image generation with Google Fonts support and better truncation logic
- Improved UI for tables with better alignment, spacing, and readability
Expand All @@ -562,14 +562,14 @@
<Update label="October 31, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "API playground enhancements, table improvements, performance optimizations, and bug fixes" }}>
## 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)**

Check warning on line 565 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L565

Don't use exclamation points in text.
- Assistant insights quality has been improved with default spam protection for abusive keywords and JSON queries.

Check warning on line 566 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L566

In general, use active voice instead of passive voice ('been improved').

## API playground improvements

- The API playground now automatically fills in default values for parameters, which saves time when testing endpoints.
- Issues with `allOf`, `oneOf`, and nested object schemas that previously caused rendering problems or incorrect field displays have been fixed, and complex API schemas now render correctly with all fields visible and properly structured.

Check warning on line 571 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L571

In general, use active voice instead of passive voice ('been fixed').
- Enum and nullable field types now display accurate labels in the playground, which makes it clearer what values are accepted and whether fields are optional.

Check warning on line 572 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L572

In general, use active voice instead of passive voice ('are accepted').
- When working with nested objects in API requests, the playground now shows proper descriptive labels for each field instead of generic placeholders, which makes it easier to understand what data to provide.
- Enum const tables and API field displays now render with improved formatting and alignment, which makes it easier to scan available options and understand field requirements.
- API playground modals now display rich MDX-formatted descriptions at the top, which gives better context for endpoints with formatted text, links, and code examples.
Expand All @@ -577,7 +577,7 @@
## Analytics changes

- Deferred analytics loading: PostHog and LogRocket now load after documentation content, which improves initial page load times and Core Web Vitals scores without affecting analytics data.
- Conditional session recording: PostHog session recording can now be enabled conditionally based on user properties or page context for more control over when recordings happen.

Check warning on line 580 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L580

In general, use active voice instead of passive voice ('be enabled').

## Visual improvements

Expand All @@ -601,7 +601,7 @@
## Insights improvements

- Improved insights page with fixed date selectors for "today" and "yesterday"
- Enhanced feedback table with improved search functionality

Check warning on line 604 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L604

Use 'capability' or 'feature' instead of 'functionality'.
- Added loading state for categories table

## Assistant improvements
Expand Down Expand Up @@ -686,7 +686,7 @@
<Update label="October 11, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "API playground improvements, analytics enhancements, web editor updates, and bug fixes" }}>
## 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

Check warning on line 689 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L689

Did you really mean 'list_pull_requests'?

Check warning on line 689 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L689

Did you really mean 'list_commits'?
- 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
Expand Down Expand Up @@ -718,14 +718,14 @@
## Bug fixes and reliability

- Fixed duplicate base paths and links in 404 recommended pages
- Auto-populated og:url tag with appropriate canonical URL

Check warning on line 721 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L721

Use 'URL' instead of 'url'.
- Added canonical tag for better SEO
- Fixed code block overscroll issues
- Made search engines ignore preview deployments for SEO purposes
- 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

Check warning on line 727 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L727

Use 'todo' instead of 'TODO'.
- Fixed directory reading support for read_external_files

Check warning on line 728 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L728

Did you really mean 'read_external_files'?

## Component and styling

Expand All @@ -741,13 +741,13 @@
- **Accessibility CLI command**: Run `mint a11y` to test your docs for accessibility issues
- **Video responses in API playground**: API playground now supports displaying video response types
- **API playground prefill**: New option to prefill API playground examples for faster testing
- **Unauthenticated feedback**: For sites using partial authentication, users can now submit feedback without being authenticated

Check warning on line 744 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L744

In general, use active voice instead of passive voice ('being authenticated').
- **Shiki theme support**: Shiki themes are now supported for code block styling
- **Twoslash for code blocks**: TypeScript and JavaScript code blocks now support Twoslash for inline type information

## Accessibility improvements

- Added comprehensive ARIA attributes across components for better screen reader support

Check warning on line 750 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L750

Spell out 'ARIA', if it's unfamiliar to the audience.
- New "skip to main content" button for keyboard navigation
- Arrow key navigation support in tab components
- Enhanced tooltips, nested lists, and code group accessibility
Expand Down Expand Up @@ -780,7 +780,7 @@

- Added support for Romanian and Czech languages in the documentation interface
- Enhanced localization capabilities with complete translation coverage for new languages
- Improved language selector functionality across all themes

Check warning on line 783 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L783

Use 'capability' or 'feature' instead of 'functionality'.

## UI and user experience improvements

Expand Down Expand Up @@ -816,7 +816,7 @@
- Fixed GitLab integration issues with larger repositories
- Improved dashboard loading performance with optimized deployment queries
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 819 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L819

Use 'capability' or 'feature' instead of 'functionality'.
</Update>

<Update label="September 13, 2025" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "AI 404 suggestions, assistant web search with external sources, security enhancement, and reliability fixes" }}>
Expand All @@ -839,7 +839,7 @@
- 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 842 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L842

Avoid using 'will'.
- Fixed a bug where copying a page from the context menu was not working on safari

## API playground and navigation
Expand All @@ -852,7 +852,7 @@
- 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

Check warning on line 855 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L855

Use 'preceding' instead of 'above'.
- Enhanced the Maple and Willow themes by adding login/logout buttons to the sidebar for easier access

## Analytics and exports
Expand Down Expand Up @@ -881,34 +881,34 @@
- 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 884 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L884

In general, use active voice instead of passive voice ('are handled').

## 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

Check warning on line 889 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L889

Avoid using 'will'.

## Performance improvements

- Performance improvement by moving the KaTeX CSS from cdnjs to our own CDN on Cloudfront for reduced latency

Check warning on line 893 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L893

Use 'CloudFront' instead of 'Cloudfront'.
</Update>

<Update label="August 23, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Image layout fixes, auth enhancements, mobile nav improvements, and web editor stability" }}>
## 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 900 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L900

Spell out 'TXT', if it's unfamiliar to the audience.

## 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

Check warning on line 905 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L905

Use 'capability' or 'feature' instead of 'functionality'.
- 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 subpaths, 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

Check warning on line 911 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L911

In general, use active voice instead of passive voice ('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
Expand All @@ -920,7 +920,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 923 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L923

Use 'capability' or 'feature' instead of 'functionality'.
</Update>

<Update label="August 16, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Performance optimizations, LLM integrations, web editor polish, and API playground enhancements" }}>
Expand All @@ -936,7 +936,7 @@

- 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.

Check warning on line 939 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L939

Use 'MDX' instead of 'mdx'.
- 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

Expand Down Expand Up @@ -968,7 +968,7 @@
- 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 971 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L971

Spell out 'RSS', if it's unfamiliar to the audience.

Check warning on line 971 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L971

Use 'path' instead of 'pathname'.

Check warning on line 971 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L971

Spell out 'RSS', if it's unfamiliar to the audience.
- Improved CLI download speed by removing sourcemaps

## Technical improvements
Expand All @@ -983,7 +983,7 @@

- 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

Check warning on line 986 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L986

In general, use active voice instead of passive voice ('are redirected').
- 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

Expand All @@ -1001,9 +1001,9 @@

## 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`.

Check warning on line 1004 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1004

Avoid using 'will'.
- Email field on login for the Mintlify dashboard now autofocuses so you can start typing immediately _(quality of life improvement)_

Check warning on line 1005 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1005

Use 'email' instead of 'Email'.
- Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)

Check warning on line 1006 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1006

Put a nonbreaking space between the number and the unit in '50ms'.
- 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`
Expand All @@ -1013,8 +1013,8 @@
- CLI bugfixes for windows and pnpm, plus CI tests to prevent regressions
- 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 1016 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1016

In general, use active voice instead of passive voice ('being set').
- Fixed theme light background color not being applied to active tab icons

Check warning on line 1017 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1017

In general, use active voice instead of passive voice ('being applied').
- 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>
Expand All @@ -1029,7 +1029,7 @@

## API playground enhancements

- Fixed `multipart/form-data` file upload functionality in the API playground

Check warning on line 1032 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1032

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed anchor link behavior so clicking them updates the URL without scrolling to top of page
- Fixed anchor link issues in nested tabs

Expand All @@ -1044,7 +1044,7 @@

- 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

Check warning on line 1047 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1047

Spell out 'GANTT', if it's unfamiliar to the audience.

Check warning on line 1047 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1047

Use 'Gantt' instead of 'GANTT'.
- Fixed CLI bugs on Windows to improve stability and added tests to prevent regression

## Technical improvements
Expand Down Expand Up @@ -1077,8 +1077,8 @@
- Added more customization options including focus mode, expandable code blocks, dark and light mode responsiveness, language dropdown menu, line numbering, and icons
</Update>

<Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}>
## AI assistant updates
<Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "The Mintie Assistant updates and subscribable changelogs" }}>

Check warning on line 1080 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1080

'The Mintie Assistant updates' should use sentence-style capitalization.

Check warning on line 1080 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1080

Did you really mean 'Mintie'?
## The Mintie 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
Expand All @@ -1087,10 +1087,10 @@

Learn more in the [assistant docs](/ai/assistant).

## Subscribable changelogs

Check warning on line 1090 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1090

Use 'subscribable' instead of 'Subscribable'.

- Automatically generate an RSS feed from changelog pages

Check warning on line 1092 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1092

Spell out 'RSS', if it's unfamiliar to the audience.
- Integrate RSS-enabled updates with Slack, email, and other tools

Check warning on line 1093 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1093

Spell out 'RSS', if it's unfamiliar to the audience.

Learn more in our new [Changelog guide](/create/changelogs)
</Update>
Expand All @@ -1111,10 +1111,10 @@
</Update>

<Update label="April 2025" tags={["New releases", "Improvements"]}>
## Web Editor 3.0

Check warning on line 1114 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1114

'Web Editor 3.0' should use sentence-style capitalization.

<Frame>
![Webeditor3 Jpe](/images/webeditor3.jpeg)

Check warning on line 1117 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1117

Did you really mean 'Jpe'?
</Frame>
Overhauled usability in the WYSIWYG editor.

Expand All @@ -1130,14 +1130,14 @@

- 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

Check warning on line 1133 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1133

In general, use active voice instead of passive voice ('being brought').
- 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

Check warning on line 1140 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1140

'AI Translations in beta' should use sentence-style capitalization.

<Frame>
![AI Translations graphic](/images/changelog/translations.png)
Expand Down Expand Up @@ -1171,7 +1171,7 @@

- OG images fixed
- Fixed icon style inconsistency for anchors without container
- Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness

Check warning on line 1174 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1174

Use 'device' instead of 'tablet'.
- 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
Expand Down Expand Up @@ -1201,15 +1201,15 @@

1. Delete your old `mint.json` file and push your changes

## CI Checks

Check warning on line 1204 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1204

'CI Checks' should use sentence-style capitalization.

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](deploy/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.

Check warning on line 1210 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1210

Use 'import' or 'load' instead of 'ingest'.

## More Themes

Check warning on line 1212 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1212

'More Themes' should use sentence-style capitalization.

<Frame>
![graphic with text "Themes v2"](/images/changelog/themes.png)
Expand All @@ -1226,11 +1226,11 @@

- [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](organize/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.

Check warning on line 1229 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1229

Avoid using 'will'.
</Update>

<Update label="January 2025" tags={["Improvements"]}>
## AI Assistant Improvements
## The Mintie Assistant Improvements

Check warning on line 1233 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1233

'The Mintie Assistant Improvements' should use sentence-style capitalization.

Check warning on line 1233 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1233

Did you really mean 'Mintie'?

- 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
Expand All @@ -1241,7 +1241,7 @@

Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.

## Revamped API Playground

Check warning on line 1244 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1244

'Revamped API Playground' should use sentence-style capitalization.

We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:

Expand All @@ -1264,18 +1264,18 @@
</Update>

<Update label="November 2024">
## AI Writer

Check warning on line 1267 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1267

'AI Writer' should use sentence-style capitalization.

<Frame>
![AI Assistant](/images/changelog/ai-assistant.jpg)
</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

Check warning on line 1274 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1274

'GitLab Integration Upgrade' should use sentence-style capitalization.

We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/deploy/gitlab) to get started.

## Web Editor

Check warning on line 1278 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1278

'Web Editor' should use sentence-style capitalization.

<Frame>
![Web Editor](/images/changelog/webeditor.jpg)
Expand All @@ -1284,16 +1284,16 @@

Check out our [docs on getting started with Web Editor](/editor).

## /llms.txt support

Check warning on line 1287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1287

'/llms.txt support' should use sentence-style capitalization.

Check warning on line 1287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1287

Use 'LLMs?' instead of 'llms'.

<Frame>
![llms.txt support](/images/changelog/llms.jpg)

Check warning on line 1290 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1290

Use 'LLMs?' instead of 'llms'.
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

## Localization

You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale.

Check warning on line 1296 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1296

Avoid using 'will'.

### Quality Improvements

Expand All @@ -1302,21 +1302,21 @@
</Update>

<Update label="October 2024">
## Changelogs

Check warning on line 1305 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1305

Use 'changelogs?' instead of 'Changelogs'.

Launched a new [Update component](/components/update) to make it easier to display and report updates (like this one) to your users.

<Frame>
![Changelog](/images/changelog/changelog.jpg)

Check warning on line 1310 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1310

Use 'changelogs?' instead of 'Changelog'.
</Frame>
## Code Line Highlighting

Check warning on line 1312 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1312

'Code Line Highlighting' should use sentence-style capitalization.

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}
const greeting = "Hello, World!";

Check warning on line 1317 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1317

Use semicolons judiciously.
function sayHello() {
console.log(greeting);

Check warning on line 1319 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1319

Use semicolons judiciously.
}
sayHello();
```
Expand Down
2 changes: 1 addition & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Ask our docs

Use the keyboard shortcut <kbd>Command</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux) to start a chat with our AI assistant trained on our documentation.
Use the keyboard shortcut <kbd>Command</kbd> + <kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>I</kbd> (Windows/Linux) to start a chat with The Mintie Assistant trained on our documentation.

Check warning on line 8 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L8

Did you really mean 'Mintie'?

## Watch video tutorials

Expand Down
2 changes: 1 addition & 1 deletion guides/geo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

Optimize your documentation for both traditional search engines and AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews.

Generative Engine Optimization (GEO) focuses on being cited by AI systems through comprehensive content and structured information, while traditional SEO targets search result rankings.

Check warning on line 10 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L10

In general, use active voice instead of passive voice ('being cited').

## GEO quickstart

### Initial setup

1. **Make sure your docs are being indexed** in your `docs.json` settings

Check warning on line 16 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L16

In general, use active voice instead of passive voice ('being indexed').
2. **Audit current pages** for missing descriptions and titles

### Content improvements
Expand All @@ -25,7 +25,7 @@

## GEO best practices

In general, well written and well structured documentation has strong GEO. You should still prioritize writing for your users, and if your content is meeting their needs, you are well on your way to optimizing for AI tools. Creating genuinely helpful content rather than optimizing for optimization's sake is rewarded by both traditional and AI search engines.

Check warning on line 28 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L28

In general, use active voice instead of passive voice ('is rewarded').

Focus on:

Expand Down Expand Up @@ -84,15 +84,15 @@

### LLMs.txt

LLMs.txt files help AI systems understand your documentation structure, similar to how sitemaps help search engines. Mintlify automatically generates LLMs.txt files for your docs. No configuration is required.

Check warning on line 87 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L87

In general, use active voice instead of passive voice ('is required').

## Testing your documentation

Test various AI tools with questions about your product and documentation to see how well your docs are being cited.

Check warning on line 91 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L91

In general, use active voice instead of passive voice ('being cited').

**Ask AI assistants specific questions about your docs:**
**Ask The Mintie Assistant specific questions about your docs:**

Check warning on line 93 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L93

Did you really mean 'Mintie'?
- "How do I set up authentication using this API?"

Check warning on line 94 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L94

Avoid first-person pronouns such as ' I '.
- "Walk me through the installation process step by step"

Check warning on line 95 in guides/geo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/geo.mdx#L95

Avoid first-person pronouns such as 'me'.

**Check that tools provide:**
- Correct code samples
Expand Down
2 changes: 1 addition & 1 deletion guides/windsurf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

## Use Windsurf with Mintlify

Windsurf's Cascade AI assistant can be tuned to write documentation according to your standards using Mintlify components. Workspace rules and memories provide persistent context about your project, ensuring more consistent suggestions from Cascade.
Windsurf's Cascade assistant can be tuned to write documentation according to your standards using Mintlify components. Workspace rules and memories provide persistent context about your project, ensuring more consistent suggestions from Cascade.

Check warning on line 11 in guides/windsurf.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/windsurf.mdx#L11

In general, use active voice instead of passive voice ('be tuned').

* **Workspace rules** are stored in your documentation repository and shared with your team.

Check warning on line 13 in guides/windsurf.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/windsurf.mdx#L13

In general, use active voice instead of passive voice ('are stored').
* **Memories** provide individual context that builds up over time.

We recommend setting up workspace rules for shared documentation standards. You can develop memories as you work, but since they are not shared, they are not consistent across team members.
Expand All @@ -37,7 +37,7 @@

- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter
- Navigation is configured in `docs.json`

Check warning on line 40 in guides/windsurf.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/windsurf.mdx#L40

'docs.json' should use sentence-style capitalization.
- We follow technical writing best practices

## Writing standards
Expand Down
2 changes: 1 addition & 1 deletion integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

<Card
title="Mixpanel"
href="/integrations/analytics/mixpanel"

Check warning on line 47 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L47

Use 'Mixpanel' instead of 'mixpanel'.
horizontal
icon={
<svg
Expand Down Expand Up @@ -89,7 +89,7 @@

<Card
title="PostHog"
href="/integrations/analytics/posthog"

Check warning on line 92 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L92

Use 'PostHog' instead of 'posthog'.
horizontal
icon={
<svg
Expand Down Expand Up @@ -696,7 +696,7 @@

| Event name | Description |
| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
| `docs.assistant.enter` | User opens the AI assistant. |
| `docs.assistant.enter` | User opens The Mintie Assistant. |

Check warning on line 699 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L699

Did you really mean 'Mintie'?
| `docs.assistant.completed` | Chat session completes. |
| `docs.assistant.source_click` | User clicks a citation in a chat response. |
| `docs.assistant.suggestion_click` | User clicks a suggested question. |
Expand Down
2 changes: 1 addition & 1 deletion organize/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
}
]
```
In this example, the `Getting started` group is hidden and the `Guides` group is visible.

Check warning on line 67 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L67

In general, use active voice instead of passive voice ('is hidden').

### Hide a tab

Expand All @@ -85,7 +85,7 @@

## Search, SEO, and AI indexing

By default, hidden pages don't appear in indexing for search engines, documentation site search, or as AI assistant context. To include hidden pages in search results and assistant context, add the `seo` property to your `docs.json`:
By default, hidden pages don't appear in indexing for search engines, documentation site search, or as The Mintie Assistant context. To include hidden pages in search results and assistant context, add the `seo` property to your `docs.json`:

Check warning on line 88 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L88

Did you really mean 'Mintie'?

```json
"seo": {
Expand All @@ -93,10 +93,10 @@
}
```

### Understanding hidden versus noindex

Check warning on line 96 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L96

Did you really mean 'noindex'?

The relationship between `hidden` and `noindex` is one-directional:

- **`hidden: true` → automatically applies `noindex`**: Hidden pages are automatically excluded from search engines, sitemaps, and AI context.
- **`noindex: true` → does NOT apply `hidden`**: Pages with `noindex: true` remain visible in navigation. They only affect search engine indexing and AI context.

Check warning on line 101 in organize/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/hidden-pages.mdx#L101

Spell out 'NOT', if it's unfamiliar to the audience.

Expand Down
2 changes: 1 addition & 1 deletion organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -695,7 +695,7 @@ This section contains the full reference for the `docs.json` file.
<ResponseField name="options" type='array of "assistant" | "copy" | "view" | "chatgpt" | "claude" | "perplexity" | "grok" | "mcp" | "add-mcp" | "cursor" | "vscode" | object' required>
Actions available in the contextual menu. The first option appears as the default.

- `assistant`: Open the AI assistant with the current page as context.
- `assistant`: Open The Mintie Assistant with the current page as context.
- `copy`: Copy the current page as Markdown to the clipboard.
- `view`: View the current page as Markdown in a new tab.
- `chatgpt`: Send the current page content to ChatGPT.
Expand Down
Loading