docs: document comment visibility in certified queries#10750
Open
mintlify[bot] wants to merge 2 commits intomasterfrom
Open
docs: document comment visibility in certified queries#10750mintlify[bot] wants to merge 2 commits intomasterfrom
mintlify[bot] wants to merge 2 commits intomasterfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
github-actions
Bot
added
the
pr:community
Member
|
Say that only description and user reuqest are being used when agent is searching for certified queries. Comments can provide additional informantion about query though |
Generated-By: mintlify-agent
keydunov
changed the title
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
1 participant
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.
Adds a section to the certified queries page explaining that Markdown comments (
<!-- ... -->) are included in the content the agent reads, while YAML frontmatter comments (# ...) are not. This gives developers control over which notes are exposed to the agent vs. kept internal.Context from the original Slack thread: this is primarily DX guidance for developers authoring certified queries.