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
14 changes: 14 additions & 0 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,29 @@
noindex: true
---

<Update label="September 27 - October 3" tags={["New releases"]} rss={{ title: "Weekly Updates", description: "Slack bot integration for Writer Agent with direct messaging and automated notifications" }}>

## Slack bot integration

- **Major release**: Comprehensive Slack bot integration for the Writer Agent system
- Bot responds to direct messages (DMs) from users with proper event filtering

Check warning on line 13 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L13

Use parentheses judiciously.

Check warning on line 13 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L13

Did you really mean 'DMs'?
- Added OAuth scopes for full functionality: `im:read`, `im:write`, `im:history`, `channels:history`, `groups:history`, `mpim:history`

Check warning on line 14 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L14

Use 'capability' or 'feature' instead of 'functionality'.
- Event subscriptions support: `message.im`, `message.channels`, `message.groups`, `message.mpim`, `app_mention`
- Real-time display of Slack bot status in dashboard
- Formatted display for pull request links and Writer Agent completion notifications
- Enhanced UI with proper Slack message formatting support (*bold text*, links, user mentions, channel references)

Check warning on line 18 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L18

Use parentheses judiciously.

</Update>

<Update label="September 20 - September 26" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Language support expansion, UI improvements, and infrastructure enhancements" }}>

## Language support expansion

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L28

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

## UI and user experience improvements

Check warning on line 30 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L30

'UI and user experience improvements' should use sentence-style capitalization.

- Fixed tab visibility issues on 404 pages to prevent incorrect active tab highlighting
- Enhanced image handling with proper width and height attribute passing for non-optimized images
Expand All @@ -21,7 +35,7 @@

## Infrastructure and performance enhancements

- Enhanced GIF image processing by skipping costly Imgix auto-formatting to reduce processing time and bandwidth usage

Check warning on line 38 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L38

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

Check warning on line 38 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L38

Did you really mean 'Imgix'?
- Optimized image serving performance with special handling for animated content

## Bug fixes and reliability
Expand All @@ -46,11 +60,11 @@

## Bug fixes and reliability

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

Check warning on line 63 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L63

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L65

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L67

Did you really mean 'onClick'?

</Update>

Expand All @@ -60,14 +74,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 77 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L77

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L84

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 @@ -75,20 +89,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 92 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L92

Avoid using 'will'.

Check warning on line 92 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L92

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L93

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L100

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

Check warning on line 100 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L100

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L102

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

Check warning on line 103 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L103

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L105

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 @@ -103,7 +117,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 120 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L120

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

## Navigation and quality of life improvements

Expand All @@ -119,16 +133,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 136 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L136

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

Check warning on line 136 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L136

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

Check warning on line 136 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L136

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L141

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L145

Did you really mean 'cdnjs'?

Check warning on line 145 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L145

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

Check warning on line 145 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L145

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

</Update>

Expand All @@ -137,18 +151,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 154 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L154

Use parentheses judiciously.

Check warning on line 154 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L154

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L159

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L165

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 @@ -160,7 +174,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 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.

Check warning on line 177 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L177

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

</Update>

Expand All @@ -169,16 +183,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 186 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L186

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

Did you really mean 'parallelization'?

Check warning on line 187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L189

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L195

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 @@ -187,18 +201,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 204 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L204

Did you really mean 'prepending'?

## Analytics and LLM integrations

Check warning on line 206 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L206

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

Check warning on line 206 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L206

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L208

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L210

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L215

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 @@ -208,10 +222,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 225 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L225

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

Check warning on line 226 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L226

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L227

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

Check warning on line 227 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L227

Use 'path' instead of 'pathname'.

Check warning on line 227 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L227

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

Check warning on line 228 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L228

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

Check warning on line 228 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L228

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -226,40 +240,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 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 ('are redirected').
- Fixed a flash of a 500 error during OAuth/JWT flows before the callback

Check warning on line 244 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L244

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L245

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

Check warning on line 245 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L245

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L252

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L256

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L261

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L262

Use 'email' instead of 'Email'.

Check warning on line 262 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L262

Did you really mean 'autofocuses'?

Check warning on line 262 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L262

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L263

Use parentheses judiciously.

Check warning on line 263 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L263

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L270

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

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 'bugfixes'?
- Improved error logging output—a quality of life upgrade for our engineering team when debugging

Check warning on line 271 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L271

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L273

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

Check warning on line 273 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L273

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L274

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L276

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 @@ -268,11 +282,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 285 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L285

Use parentheses judiciously.

## API playground enhancements

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

Check warning on line 289 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L289

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 @@ -284,15 +298,15 @@

## Performance and reliability

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

Check warning on line 301 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L301

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L302

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

Check warning on line 303 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L303

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L304

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L308

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

Check warning on line 309 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L309

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 @@ -300,16 +314,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 317 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L317

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L322

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L326

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 @@ -322,7 +336,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 339 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L339

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 @@ -330,10 +344,10 @@
Learn more in the [assistant docs](/guides/assistant).

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

Check warning on line 347 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L347

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

Check warning on line 348 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L348

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

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

Check warning on line 350 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L350

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

</Update>

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

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

Check warning on line 365 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L365

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

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

Check warning on line 369 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L369

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

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

Check warning on line 372 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L372

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

Expand All @@ -364,21 +378,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 381 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L381

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L388

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L395

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

<Frame>
![AI Translations graphic](/images/changelog/translations.png)
Expand Down Expand Up @@ -413,10 +427,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 430 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L430

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L433

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

<Update label="February 2025" tags={["New releases", "Improvements"]}>
Expand All @@ -429,7 +443,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 446 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L446

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

```bash
npm i mint@latest -g
Expand All @@ -443,15 +457,15 @@

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

## CI Checks

Check warning on line 460 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L460

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L462

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L466

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

## More Themes

Check warning on line 468 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L468

'More Themes' should use sentence-style capitalization.

<Frame>
![graphic with text "Themes v2"](/images/changelog/themes.png)
Expand All @@ -468,24 +482,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 485 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L485

Avoid using 'will'.
</Update>

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

Check warning on line 489 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L489

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L496

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L500

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L502

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 @@ -506,27 +520,27 @@
</Update>

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

Check warning on line 523 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L523

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L530

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L532

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

Check warning on line 532 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L532

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

## Web Editor

Check warning on line 534 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L534

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L541

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

## /llms.txt support

Check warning on line 543 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L543

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

<Frame>
![llms.txt support](/images/changelog/llms.jpg)
Expand All @@ -535,30 +549,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 552 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L552

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L557

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L563

Use parentheses judiciously.

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

Check warning on line 568 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L568

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L573

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

Check warning on line 575 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L575

Use semicolons judiciously.
}
sayHello();
```
Expand Down
4 changes: 4 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@
"icon": "messages-square",
"pages": [
"integrations/support/overview",
"integrations/support/slack",
"integrations/support/intercom",
"integrations/support/front"
]
Expand Down Expand Up @@ -483,6 +484,7 @@
"icon": "messages-square",
"pages": [
"fr/integrations/support/overview",
"integrations/support/slack",
"fr/integrations/support/intercom",
"fr/integrations/support/front"
]
Expand Down Expand Up @@ -750,6 +752,7 @@
"icon": "messages-square",
"pages": [
"es/integrations/support/overview",
"integrations/support/slack",
"es/integrations/support/intercom",
"es/integrations/support/front"
]
Expand Down Expand Up @@ -1017,6 +1020,7 @@
"icon": "messages-square",
"pages": [
"zh/integrations/support/overview",
"integrations/support/slack",
"zh/integrations/support/intercom",
"zh/integrations/support/front"
]
Expand Down
8 changes: 8 additions & 0 deletions integrations/support/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ description: "Integrate with a support widget"
---

<CardGroup>
<Card
title="Slack"
href="/integrations/support/slack"
icon="slack"
horizontal
>
Integrate Writer Agent with Slack for automated documentation notifications
</Card>
<Card
title="Intercom"
href="/integrations/support/intercom"
Expand Down
120 changes: 120 additions & 0 deletions integrations/support/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: "Slack"
description: "Integrate Mintlify's Writer Agent with Slack for automated documentation notifications"
icon: "slack"
---

<Info>
The Slack integration is available for Writer Agent users and enables automated notifications when documentation updates are completed.
</Info>

## About the Slack integration

The Slack integration connects Mintlify's Writer Agent with your Slack workspace, providing real-time notifications when documentation updates are completed. The bot can send direct messages and post to channels, keeping your team informed about documentation changes.

### Key features

- **Direct message handling**: Receive notifications via direct messages from the Mintlify bot
- **Channel notifications**: Get updates posted to specific channels
- **Pull request links**: Automatically formatted links to completed documentation updates
- **Real-time status**: Live updates on Writer Agent completion status

## Setting up the Slack integration

### Prerequisites

- Active Mintlify Writer Agent subscription
- Slack workspace admin permissions
- Access to your Slack app configuration

### Required OAuth scopes

Configure your Slack app with the following OAuth scopes for full 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

### Installation steps

1. **Create a Slack app** in your workspace or use an existing one
2. **Configure OAuth scopes** as listed above in your app's OAuth & Permissions section
3. **Set up event subscriptions** in your app's Event Subscriptions section
4. **Install the app** to your workspace
5. **Configure the integration** in your Mintlify dashboard

## Using the Slack integration

### Notification types

The Slack bot sends notifications for:

- **Documentation updates completed**: When Writer Agent finishes updating your docs
- **Pull request creation**: Links to newly created pull requests with documentation changes
- **Status updates**: Real-time updates on Writer Agent processing status

### Message formatting

The bot uses standard Slack formatting:

- **Bold text** using single asterisks (`*bold*`)
- **Links** formatted as `<url|display text>`
- **User mentions** as `<@USER_ID>`
- **Channel references** as `<#CHANNEL_ID>`

### Dashboard integration

The Mintlify dashboard displays:

- Real-time Slack bot status
- Writer Agent completion notifications
- Formatted display for pull request links
- Message history and delivery status

## Troubleshooting

### Common issues

<AccordionGroup>
<Accordion title="Bot not receiving messages">
Ensure the `im:history` scope is enabled - this is critical for receiving DM events. Check that event subscriptions are properly configured for `message.im`.
</Accordion>

<Accordion title="Missing channel notifications">
Verify that the bot has been added to the target channel and has the appropriate `channels:history` or `groups:history` scope depending on channel type.
</Accordion>

<Accordion title="Formatting issues">
The bot automatically handles Slack message formatting. If links or mentions aren't working, check that the message content follows Slack's formatting standards.
</Accordion>
</AccordionGroup>

### Support

If you encounter issues with the Slack integration:

1. Verify all required OAuth scopes are enabled
2. Check that event subscriptions are properly configured
3. Ensure the bot is installed and has necessary permissions
4. Contact [Mintlify support](mailto:[email protected]) for additional assistance

## Security considerations

- The bot only processes messages and events it's explicitly subscribed to
- Bot messages are automatically filtered to prevent loops
- All communications use Slack's secure API endpoints
- No sensitive documentation content is stored in Slack messages
Loading