Document agent feedback for markdown exports#5212
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Shipped in mintlify/mint#6941: When agent feedback is enabled, markdown exports include an embedded instruction block with a POST endpoint that AI agents can use to report incorrect, outdated, or confusing documentation.
Note
Low Risk
Documentation-only changes that describe an existing feedback capability; no runtime behavior or data handling is modified.
Overview
Adds Agent feedback documentation to
ai/markdown-export.mdx, explaining the embedded instruction block included in Markdown exports and the JSONPOSTformat agents should use to submit issues.Updates
optimize/feedback.mdxto list Agent feedback as a feedback type and links back to the Markdown export section for setup/usage details.Reviewed by Cursor Bugbot for commit 0e2d12e. Bugbot is set up for automated code reviews on this repo. Configure here.