docs: document Feedback docs updates workflow#5893
Open
mintlify[bot] wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
Documents the new Feedback docs updates workflow, which turns recent contextual feedback on published docs into targeted documentation pull requests on a recurring schedule.
Changes
workflows/enable.mdxcovering prerequisites, schedule, signal source, output, and configurable options.optimize/feedback.mdxso readers exploring feedback discover the automated workflow.Context
Triggered by mintlify/server#5399, which introduces a new scheduled workflow that ranks pages by negative and detailed contextual feedback, summarizes themes for the agent, and opens a pull request with targeted updates.
Note
Low Risk
Low risk: documentation-only additions and cross-links; no product logic or data handling changes.
Overview
Adds documentation for the
Feedback docs updatesworkflow inworkflows/enable.mdx, including prerequisites, schedule/trigger behavior, ranking signals, PR output, and configuration options (instructions + update mode, with note about redaction of secrets).Updates
optimize/feedback.mdx(andes/+fr/translations) to include a new section that points readers to enabling the workflow to automate doc improvements from recent contextual feedback.Reviewed by Cursor Bugbot for commit 32baf9d. Bugbot is set up for automated code reviews on this repo. Configure here.