docs: clarify how workflow triggers and prompts interact#5899
Closed
mintlify[bot] wants to merge 1 commit into
Closed
docs: clarify how workflow triggers and prompts interact#5899mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
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
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
Adds a short subsection to the Workflows overview explaining that triggers fire unconditionally and that conditional "should I update docs?" logic belongs in the prompt.
Changes
workflows/index.mdx.Context
Recurring assistant questions in the last week asked whether workflows could "only run when a doc change is needed," whether push triggers filter by path, and how schedule triggers affect run volume. The overview previously listed the two trigger types without explaining the trigger-vs-prompt division of responsibility.
Note
Low Risk
Low risk documentation-only change that clarifies workflow behavior and guidance without affecting runtime logic.
Overview
Adds a new "How triggers and prompts work together" section to the Workflows overview to clarify that triggers run on every qualifying push/schedule occurrence (no path filtering or pre-flight skip) and that conditional/no-op decision-making should be implemented in the workflow prompt.
Also advises switching from push-based triggers to scheduled runs to reduce run frequency, with a note that failed runs don’t count toward usage limits.
Reviewed by Cursor Bugbot for commit 9eb48ee. Bugbot is set up for automated code reviews on this repo. Configure here.