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
155 changes: 155 additions & 0 deletions ai/slack-bot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: "Slack bot"
description: "Get Writer Agent notifications and interact with your documentation directly in Slack"
icon: "slack"
---

<Info>
The Slack bot integration is available on [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-bot).
</Info>

## About the Slack bot

Check warning on line 11 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L11

'About the Slack bot' should use sentence-style capitalization.

The Slack bot brings your documentation's Writer Agent capabilities directly into your Slack workspace. It provides real-time notifications when documentation updates are completed and enables direct messaging for documentation assistance.

Check warning on line 13 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L13

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

The bot integrates with Mintlify's Writer Agent system to:

* **Send completion notifications** when Writer Agent finishes processing documentation updates
* **Handle direct messages** for documentation questions and assistance
* **Format messages properly** with support for Slack's native formatting (bold text, links, user mentions, channel references)

Check warning on line 19 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L19

Use parentheses judiciously.
* **Display pull request links** and other relevant information in a user-friendly format

## Setting up the Slack bot

### Prerequisites

Before setting up the Slack bot, ensure you have:

* A Slack workspace with admin permissions

Check warning on line 28 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L28

Use 'administrator' instead of 'admin'.
* A Mintlify Pro or Custom plan
* Access to your Slack app configuration

### Required OAuth scopes

Configure your Slack app with the following OAuth scopes for full functionality:

Check warning on line 34 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L34

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

#### Bot token scopes
* `im:read` - Read DM channel information
* `im:write` - Send DM responses
* `im:history` - **Critical:** Receive DM message events
* `channels:history` - Receive channel message events
* `groups:history` - Receive private channel events
* `mpim:history` - Receive group DM events

### Event subscriptions

Configure these bot event subscriptions in your Slack app settings:

* `message.im` - Direct message events
* `message.channels` - Public channel messages
* `message.groups` - Private channel messages
* `message.mpim` - Group DM messages
* `app_mention` - When the bot is mentioned

Check warning on line 52 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L52

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

### Installation steps

1. **Create a Slack app** in your workspace or use an existing one
2. **Configure OAuth scopes** as listed above

Check warning on line 57 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L57

Use 'preceding' instead of 'above'.
3. **Set up event subscriptions** for the required message events
4. **Install the app** to your workspace
5. **Connect to Mintlify** through your dashboard settings

## Using the Slack bot

Check warning on line 62 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L62

'Using the Slack bot' should use sentence-style capitalization.

### Direct messaging

You can send direct messages to the bot for documentation assistance:

1. **Find the bot** in your Slack workspace
2. **Send a direct message** with your question or request
3. **Receive responses** with relevant documentation information

The bot will respond to direct messages and exclude its own messages to prevent loops.

Check warning on line 72 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L72

Avoid using 'will'.

### Notification display

The bot automatically sends notifications to configured channels when:

* Writer Agent completes documentation updates
* Pull requests are processed

Check warning on line 79 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L79

In general, use active voice instead of passive voice ('are processed').
* Documentation builds finish

### Message formatting

The bot properly handles Slack's native formatting:

* **Bold text** using single asterisks (`*bold*`)

Check warning on line 86 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L86

Use parentheses judiciously.
* **Links** formatted as `<url|display text>`
* **User mentions** as `<@USER_ID>`
* **Channel references** as `<#CHANNEL_ID>`

## Dashboard integration

Monitor your Slack bot activity through the Mintlify dashboard:

### Real-time status

View the current status of your Slack bot integration, including:

* Connection status
* Recent activity
* Message delivery status

### Notification settings

Configure which events trigger Slack notifications:

* Writer Agent completion notifications
* Documentation build status
* Error alerts and warnings

### Message history

Review recent bot interactions and notifications sent to your Slack workspace.

## Troubleshooting

### Bot not responding to direct messages

1. **Verify OAuth scopes** - Ensure `im:history` scope is enabled

Check warning on line 119 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L119

In general, use active voice instead of passive voice ('is enabled').
2. **Check event subscriptions** - Confirm `message.im` events are configured

Check warning on line 120 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L120

In general, use active voice instead of passive voice ('are configured').
3. **Reinstall the app** if permissions were recently changed

### Missing notifications

1. **Review notification settings** in your Mintlify dashboard
2. **Check channel permissions** - Ensure the bot can post to target channels
3. **Verify webhook URLs** are correctly configured

### Message formatting issues

The bot automatically handles Slack formatting. If messages appear incorrectly:

1. **Check message content** for unsupported formatting
2. **Review channel settings** for any message restrictions
3. **Contact support** if formatting issues persist

## Best practices

### Channel organization

* **Dedicate channels** for documentation notifications
* **Use threading** for related discussions
* **Pin important** bot messages for easy reference

### User engagement

* **Train team members** on how to interact with the bot
* **Share documentation links** from bot responses
* **Use mentions** to involve relevant team members in discussions

### Monitoring

* **Review bot activity** regularly through the dashboard
* **Monitor message volume** to understand usage patterns
* **Adjust notification settings** based on team feedback
11 changes: 10 additions & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,16 @@
noindex: true
---

<Update label="September 14 - September 19" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "GitLab integration enhancements, app router migration progress, authentication improvements, and bug fixes" }}>
<Update label="September 14 - September 19" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "New Slack bot integration, GitLab integration enhancements, app router migration progress, authentication improvements, and bug fixes" }}>

Check warning on line 8 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L8

'New Slack bot integration' should use sentence-style capitalization.

## New Slack bot integration

- **Major release**: Slack bot for instant documentation access - responds to DMs, @mentions, and questions in your `#ask-ai` channel

Check warning on line 12 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L12

Did you really mean 'DMs'?
- Zero-friction setup with one-click installation directly from your Mintlify dashboard
- Contextual answers by searching your entire documentation to provide relevant, accurate responses
- Deflect support interruptions by turning daily questions into instant, self-serve answers

Learn more in our [Slack bot guide](/ai/slack-bot).

Check warning on line 17 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L17

Try to avoid using first-person plural like 'our'.

## GitLab integration enhancements

Expand All @@ -20,11 +29,11 @@

## Bug fixes and reliability

- Fixed app router socket update functionality for real-time features

Check warning on line 32 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L32

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 34 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L34

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed history status endpoint reliability
- Resolved middleware edge cases and onClick event handling issues

Check warning on line 36 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L36

Did you really mean 'onClick'?

</Update>

Expand All @@ -34,14 +43,14 @@

- **Major enhancement**: AI suggested pages on 404 pages, [when someone hits a dead link → AI agent reads the path → suggests semantically similar pages](https://x.com/mintlify/status/1966625627773059495)
- **Major release**: web search for assistant can now include external sources
_Note: Contact us to enable this feature for your site._

Check warning on line 46 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L46

Try to avoid using first-person plural like 'us'.

## Assistant and MCP

- Fixed a bug where the assistant would be incorrectly rate limited due to time window not sliding correctly
- Fixed a bug with assistant tool calling to properly handle empty `text` blocks
- Fixed a bug where MCP server name's concatenated with tool calls were sometimes exceeding the 60 character length MCP clients enforce
- Fixed a bug where the assistant menu would have a height several times larger than the viewport and scroll forever

Check warning on line 53 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L53

Did you really mean 'viewport'?
- Fixed a bug where assistant spend values could display with greater than two decimal places in the dashboard

## Web editor and deployments
Expand All @@ -49,20 +58,20 @@
- Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes
- Fixed a bug where preview deployments wouldn't work for branches with `=` in the name
- Fixed a bug where long branch names would overflow modals on preview deployment creations
- Quality of life improvement where email query parameter will prefill the input on signup invitations

Check warning on line 61 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L61

Avoid using 'will'.

Check warning on line 61 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L61

Did you really mean 'signup'?
- Fixed a bug where copying a page from the context menu was not working on safari

Check warning on line 62 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L62

Use 'wasn't' instead of 'was not'.

## API playground and navigation

- Multiple API playground response codes now display in a controlled styled select menu instead of the system default select menu when focused
- You can now use the [`expanded` field on navigation groups in your `docs.json` to make them be default open](https://mintlify.com/docs/navigation#default-expanded-state)

## SEO and UI

Check warning on line 69 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L69

'SEO and UI' should use sentence-style capitalization.

Check warning on line 69 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L69

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

- 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

Check warning on line 71 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L71

Use 'weren't' instead of 'were not'.
- Fixed a bug where youtube embeds would flash in and out on load

Check warning on line 72 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L72

Did you really mean 'youtube'?
- 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 74 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L74

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 All @@ -77,7 +86,7 @@
## Major release: Enhanced feedback collection

- **Major improvement**: Readers can now give more detailed feedback after selecting *thumbs up/down*, including options and written comments. You can also collect feedback on code blocks and view all responses in your dashboard analytics.
_Note: Contact us to enable this feature for your site._

Check warning on line 89 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L89

Try to avoid using first-person plural like 'us'.

## Navigation and quality of life improvements

Expand All @@ -93,16 +102,16 @@
- Fixed a bug where Google was indexing raw `*.md` files because they were missing a `x-robots-tag noindex` header
- Fixed a bug with OAuth on protected docs where it wouldn't redirect you back to your starting page once you completed the flow successfully
- Fixed a bug on previews of auth protected docs where you weren't able to see the entire navigation bar
- Bug fixes to how SVGs are handled with our new image CDN

Check warning on line 105 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L105

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

Check warning on line 105 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L105

Try to avoid using first-person plural like 'our'.

Check warning on line 105 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L105

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

## 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 110 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L110

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 114 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L114

Did you really mean 'cdnjs'?

Check warning on line 114 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L114

Try to avoid using first-person plural like 'our'.

Check warning on line 114 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L114

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

</Update>

Expand All @@ -111,18 +120,18 @@
## Image handling improvements

- **Major improvement**: Images no longer cause layout shift by default, even when width and height attributes aren't specified—automatic sizing prevents content jumping during page loads
- All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage

Check warning on line 123 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L123

Use parentheses judiciously.

Check warning on line 123 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L123

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 128 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L128

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 subdirectories, if you serve docs at `https://yourdomain.com/docs`, authentication now works seamlessly
- Fixed sidebar display bug that incorrectly showed when only one link was configured

Check warning on line 134 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L134

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 @@ -134,7 +143,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 146 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L146

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

Check warning on line 146 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L146

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

</Update>

Expand All @@ -143,16 +152,16 @@
## Performance and build optimizations

- MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages.
- Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved)

Check warning on line 155 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L155

Use parentheses judiciously.
- Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend

Check warning on line 156 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L156

Did you really mean 'parallelization'?

Check warning on line 156 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L156

Try to avoid using first-person plural like 'our'.
- Reduced page size by eliminating duplicate `navigation` data in each page's `rsc` payload—performance gains most noticeable with high page counts or complex navigation structures
- More aggressive prefetching enables instant page loads more frequently

Check warning on line 158 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L158

Did you really mean 'prefetching'?

## API playground and OpenAPI enhancements

- OpenAPI to MCP conversion moved to backend, enabling hosted MCP servers to contain tools (expect clearer documentation and config options soon)
- Added Ruby support to API playground
- We added a feature such that you can now [specify API pages using just your docs.json](/api-playground/openapi-setup#auto-populate-api-pages) without creating any new mdx files.

Check warning on line 164 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L164

Try to avoid using first-person plural like 'We'.
- 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 All @@ -161,18 +170,18 @@
- File creation/renaming now saves changes when clicking away instead of requiring Enter key press
- Fixed branch navigation where changing URL to specific branch would redirect to last active branch instead of intended destination
- Properly URL encode branch titles containing `/` to prevent navigation breakage
- Fixed `Ctrl+K` link shortcut in monorepo dashboard Editor that was prepending docs repo path and creating broken links

Check warning on line 173 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L173

Did you really mean 'prepending'?

## Analytics and LLM integrations

Check warning on line 175 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L175

'Analytics and LLM integrations' should use sentence-style capitalization.

Check warning on line 175 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L175

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

- Custom `llms.txt` and `llms-full.txt` support—add to docs repo root to serve at `/llms.txt` and `/llms-full.txt` endpoints for LLM customization

Check warning on line 177 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L177

Spell out 'LLM', if it's unfamiliar to the audience.
- Added [Hightouch analytics integration](/integrations/analytics/hightouch#hightouch)
- Enhanced context menu analytics tracking (dashboard viewing coming soon)

Check warning on line 179 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L179

Use parentheses judiciously.
- Added e2e tests for `llms.txt` and `llms-full.txt` to ensure correct serving

## Component and styling enhancements

- Support for custom classnames in `h{1-4}` tags for applying custom heading styles

Check warning on line 184 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L184

Did you really mean 'classnames'?
- Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode
- Added CSS selectors to [breadcrumbs](/navigation#breadcrumbs) for custom CSS targeting
- Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height
Expand All @@ -182,10 +191,10 @@
## Bug fixes and reliability

- Fixed PDF render issues with certain page titles by sanitizing characters that cause generation problems
- Resolved CLI error `Cannot convert undefined or null to object` when encountering empty OpenAPI JSON files

Check warning on line 194 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L194

Use 'command-line tool' instead of 'CLI'.
- Fixed custom `docs.json` open-graph metatags being overwritten by generated ones

Check warning on line 195 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L195

Did you really mean 'metatags'?
- Fixed RSS feed button clicks when landing on anchor links by using origin + pathname for RSS links

Check warning on line 196 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L196

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

Check warning on line 196 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L196

Use 'path' instead of 'pathname'.

Check warning on line 196 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L196

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

Check warning on line 197 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L197

Use 'command-line tool' instead of 'CLI'.

Check warning on line 197 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L197

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -200,40 +209,40 @@

- Group-level public access: make entire page groups public via `docs.json` so you don’t need `public: true` on each page ([learn more](https://mintlify.com/docs/authentication-personalization/authentication-setup#group-level))
- Support [`logoutURL` in OAuth configuration](https://mintlify.com/docs/authentication-personalization/authentication-setup#implementation-3) to delete upstream cookies and complete sign-out
- On OAuth errors, users are redirected to your specified `logoutURL` to restart the auth flow

Check warning on line 212 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L212

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

Check warning on line 213 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L213

Spell out 'JWT', if it's unfamiliar to the audience.
- Auto-strip `https://` from URLs in OAuth/JWT auth configuration to prevent misconfiguration

Check warning on line 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

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

Check warning on line 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

Did you really mean 'misconfiguration'?

## API playground enhancements

- New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs
- `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`)
- You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples
- [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools

Check warning on line 221 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L221

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

## Assistant updates

- Fixed an issue where the action menu (containing options like copy and thumbs up) for older messages disappeared when new ones streamed in

Check warning on line 225 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L225

Use parentheses judiciously.
- Fixed accessibility of nested `/mcp/...` pages after the [hosted MCP servers release](https://mintlify.com/docs/ai/model-context-protocol#accessing-your-mcp-server) from last week

## Performance and reliability

- All image and video assets present in your docs repo are now served at the appropriate path on your domain. For example, if you have `/assets/marketing/my-logo.png` in your repo, it will be available at `https://mydocsurl.extension/assets/marketing/my-logo.png`.

Check warning on line 230 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L230

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 231 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L231

Use 'email' instead of 'Email'.

Check warning on line 231 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L231

Did you really mean 'autofocuses'?

Check warning on line 231 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L231

Use parentheses judiciously.
- Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)

Check warning on line 232 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L232

Use parentheses judiciously.

Check warning on line 232 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L232

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`

## Technical improvements

- CLI bugfixes for windows and pnpm, plus CI tests to prevent regressions

Check warning on line 239 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L239

Use 'command-line tool' instead of 'CLI'.

Check warning on line 239 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L239

Did you really mean 'bugfixes'?
- Improved error logging output—a quality of life upgrade for our engineering team when debugging

Check warning on line 240 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L240

Try to avoid using first-person plural like 'our'.
- 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 242 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L242

Use 'wasn't' instead of 'was not'.

Check warning on line 242 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L242

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 243 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L243

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

Check warning on line 245 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L245

Try to avoid using first-person plural like 'us'.
</Update>

<Update label="July 27 - August 2" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Authentication improvements, search enhancements, and assistant API" }}>
Expand All @@ -242,11 +251,11 @@
- Local development improvements to auth, enabling faster development of auth features and bug fixes in this product area
- Preview deployments now available for auth-protected sites
- Fixed redirect behavior to properly return users to their original page after authentication
- Fixed logout button display for full authentication (previously only worked for partial authentication)

Check warning on line 254 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L254

Use parentheses judiciously.

## API playground enhancements

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

Check warning on line 258 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L258

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 @@ -258,15 +267,15 @@

## Performance and reliability

- Made search feel more crisp and accurate by aborting debounced requests as you type

Check warning on line 270 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L270

Did you really mean 'debounced'?
- Resource provisions for a new CDN - expect image asset and page load times to improve soon

Check warning on line 271 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L271

Spell out 'CDN', if it's unfamiliar to the audience.
- Fixed bugs for rendering complex Mermaid diagrams like GANTT charts

Check warning on line 272 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L272

Spell out 'GANTT', if it's unfamiliar to the audience.
- Fixed CLI bugs on Windows to improve stability and added tests to prevent regression

Check warning on line 273 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L273

Use 'command-line tool' instead of 'CLI'.

## Technical improvements

- Added OpenTelemetry for traces in NextJS application to improve time to first byte for customers

Check warning on line 277 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L277

Use 'app' instead of 'application'.
- Migrated from Octokit to GitHub API Client to improve latency in the web editor experience

Check warning on line 278 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L278

Did you really mean 'Octokit'?
- Fixed duplicate meta tags for OpenGraph
- Upgraded MongoDB from version 6 to 7 for improved performance and new features
</Update>
Expand All @@ -274,16 +283,16 @@
<Update label="July 2025" tags={["New releases", "Improvements"]} rss={{ title: "July Product Updates", description: "Slack app integration, hosted MCP servers, Cursor integration, and performance improvements" }}>
## Slack app

- Zero friction access: Bot responds to DMs, @mentions, and any question in your `#ask-ai` channel

Check warning on line 286 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L286

Did you really mean 'DMs'?
- One-click setup: Install directly from your Mintlify dashboard in seconds
- Contextual answers: Searches your entire documentation to provide relevant, accurate responses
- Deflect support interruptions: Turn daily questions into instant, self-serve answers

Learn more in our [Slack app guide](/ai/slack-app).

Check warning on line 291 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L291

Try to avoid using first-person plural like 'our'.

## Hosted MCP servers

Deploy hosted Model Context Protocol (MCP) servers directly through Mintlify to integrate with AI tool like Claude, Cursor, and others. Learn more in our [MCP guide](/ai/model-context-protocol).

Check warning on line 295 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L295

Try to avoid using first-person plural like 'our'.

Help users quickly connect your MCP server to Cursor or VS Code from any page in your docs via the contextual menu. See [Contextual menu](/ai/contextual-menu) for more information.

Expand All @@ -296,7 +305,7 @@
<Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}>
## AI assistant updates

- Improved accuracy through agentic RAG with tool calling

Check warning on line 308 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L308

Spell out 'RAG', if it's unfamiliar to the audience.
- Provides navigable links to referenced pages so that users can go directly to the source of answers
- Copy shortcut for code examples generated by assistant
- "Ask AI" shortcut on code blocks in documentation to generate explanations from the assistant
Expand All @@ -304,10 +313,10 @@
Learn more in the [assistant docs](/guides/assistant).

## Subscribable changelogs
- Automatically generate an RSS feed from changelog pages

Check warning on line 316 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L316

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

Check warning on line 317 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L317

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

Learn more in our new [Changelog guide](/guides/changelogs)

Check warning on line 319 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L319

Try to avoid using first-person plural like 'our'.

</Update>

Expand All @@ -322,14 +331,14 @@
Learn more at [API playground docs.](/api-playground/)

## `mint update`
Can now use `mint update` to update your CLI.

Check warning on line 334 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L334

Use 'command-line tool' instead of 'CLI'.
</Update>

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

Check warning on line 338 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L338

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

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

Check warning on line 341 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L341

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

Expand All @@ -338,21 +347,21 @@
- Search for file names using ⌘ \+ P shortcut
- Pages load 10x faster
- Faster load times when searching for a branch
- Page options tab to configure layout, title, & metadata for SEO

Check warning on line 350 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L350

Spell out 'SEO', if it's unfamiliar to the audience.
- Floating toolbar when you highlight text

**Additional fixes**

- Fixed top margin for changelog components
- Improved reliability of right click behavior
- After clicking publish, you’ll stay on the same page instead of being brought to an empty state

Check warning on line 357 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L357

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 364 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L364

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

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

- 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 399 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L399

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

Check warning on line 402 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L402

Did you really mean 'Codeblocks'?
</Update>

<Update label="February 2025" tags={["New releases", "Improvements"]}>
Expand All @@ -403,7 +412,7 @@

Upgrade from `mint.json` to `docs.json` with the following steps:

1. Make sure your CLI is the latest version

Check warning on line 415 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L415

Use 'command-line tool' instead of 'CLI'.

```bash
npm i mint@latest -g
Expand All @@ -417,15 +426,15 @@

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

## CI Checks

Check warning on line 429 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L429

'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](settings/ci).

Check warning on line 431 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L431

Try to avoid using first-person plural like 'our'.

## .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 435 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L435

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

## More Themes

Check warning on line 437 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L437

'More Themes' should use sentence-style capitalization.

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

- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
- [Dropdown component](navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if there’s a parsing error and use AI to suggest fixes.

Check warning on line 454 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L454

Avoid using 'will'.
</Update>

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

Check warning on line 458 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L458

'AI Assistant Improvements' should use sentence-style capitalization.

- New UI with dedicated chat page & pre-filled prompts
- Stability improvements. For example, bug fixes of editing the wrong file or no files at all
- More robust knowledge for adding & editing components
- Improved `docs.json` file editing

## Partial Authentication

Check warning on line 465 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L465

'Partial Authentication' should use sentence-style capitalization.

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 469 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L469

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

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

Check warning on line 471 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L471

Try to avoid using first-person plural like 'We'.

- Easier detail expansion for an overview of a field
- More intuitive nested design. For example, adding or deleting items
Expand All @@ -480,27 +489,27 @@
</Update>

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

Check warning on line 492 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L492

'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 499 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L499

'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](/settings/gitlab) to get started.

Check warning on line 501 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L501

Try to avoid using first-person plural like 'We'.

Check warning on line 501 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L501

Try to avoid using first-person plural like 'our'.

## Web Editor

Check warning on line 503 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L503

'Web Editor' should use sentence-style capitalization.

<Frame>
![Web Editor](/images/changelog/webeditor.jpg)
</Frame>
We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.

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

Check warning on line 510 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L510

Try to avoid using first-person plural like 'our'.

## /llms.txt support

Check warning on line 512 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L512

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

<Frame>
![llms.txt support](/images/changelog/llms.jpg)
Expand All @@ -509,30 +518,30 @@

## 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 521 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L521

Avoid using 'will'.

### Quality Improvements

- Return chat & search results based on the current version that the user is reading
- Authenticate users with OAuth, in addition to JWT or Shared Session tokens.

Check warning on line 526 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L526

Spell out 'JWT', if it's unfamiliar to the audience.
</Update>

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

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

Check warning on line 532 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L532

Use parentheses judiciously.

<Frame>
![Changelog](/images/changelog/changelog.jpg)
</Frame>
## Code Line Highlighting

Check warning on line 537 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L537

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

Check warning on line 542 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L542

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

Check warning on line 544 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L544

Use semicolons judiciously.
}
sayHello();
```
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"group": "AI optimization",
"pages": [
"guides/assistant",
"ai/slack-bot",
"ai/llmstxt",
"ai/contextual-menu",
"ai/model-context-protocol",
Expand Down