docs: add Assistant.md custom instructions for the docs assistant#435
Merged
ketanyekale merged 1 commit intoJul 22, 2026
Merged
Conversation
ketanyekale
approved these changes
Jul 22, 2026
pouravraj98
approved these changes
Jul 22, 2026
adityagokula2210
approved these changes
Jul 22, 2026
siva-cometchat
approved these changes
Jul 22, 2026
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.
Description
Adds a
.mintlify/Assistant.mdfile to give the Mintlify docs assistant custom instructions.Assistant.mdis a Mintlify convention — the file's contents are added to the assistant's system prompt and used as system-level context for every response. They supplement rather than replace Mintlify's default instructions. There is no corresponding setting indocs.jsonand nothing to enable in the dashboard; the file's presence is the configuration.Reference: https://www.mintlify.com/docs/assistant/customize
The file is placed in
.mintlify/rather than the project root because Mintlify serves a root-levelAssistant.mdpublicly at/assistant.md. The.mintlify/directory is not served publicly.What the instructions cover:
YOUR_API_KEY/<APP_ID>placeholders and the documentedsuperhero1–superhero5sample users.Why: the assistant currently has no instruction against requesting credentials during troubleshooting. Prompting a developer to paste an Auth Key into a chat box is a bad outcome regardless of what happens downstream, and it is cheap to prevent at the instruction layer.
Related Issue(s)
N/A
Type of Change
Checklist
Additional Information
No user-visible page is added. The file sits in
.mintlify/, which Mintlify does not serve publicly, and is not referenced innavigationindocs.json. Nothing about the site's appearance changes.Verify after deploy: request
https://www.cometchat.com/docs/assistant.mdand confirm it does not return the file.Scope of effect: these instructions shape the assistant's responses. They do not filter, block, or alter what a user submits.
Rollback: delete the file — Mintlify's documented removal path for custom instructions.
Not tested in local preview — I don't have Mintlify dashboard access, so I couldn't run
mint devto verify assistant behavior. Requesting a reviewer with dashboard access to confirm before merge, particularly that ordinary questions mentioning App ID and region don't trigger an unnecessary warning.Screenshots
N/A — no visual changes.