Document ?assistant URL parameter#5620
Open
mintlify[bot] wants to merge 2 commits intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Generated-By: mintlify-agent
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
?assistantURL query parameter on the Use the assistant page. This parameter opens the assistant chat panel from any documentation page and optionally submits an initial message, enabling deep links from emails, support replies, in-app banners, and onboarding flows.The page's frontmatter already advertised URL parameters as a way to open the assistant, but the corresponding section was missing. This change adds it.
Changes
?search=.Source PR
Adds documentation for the user-facing change shipped in mintlify/mint#7441, which re-enables the
?assistant=query parameter (originally removed and now safely re-introduced after sanitization landed).Note
Low Risk
Documentation-only changes that add usage guidance for a URL query parameter; no runtime or security-sensitive code is modified.
Overview
Adds a new URL parameters section to
assistant/use.mdxdocumenting how?assistantand?assistant=<message>open the assistant (including URL-encoded examples), how the query param is removed on close, and that it is ignored for users without access.Mirrors the same documentation updates in the Spanish, French, and Chinese versions, and cross-references
?search=<query>for prefilled search.Reviewed by Cursor Bugbot for commit f971f48. Bugbot is set up for automated code reviews on this repo. Configure here.