docs: tighten style in workflows pages#6032
Merged
Merged
Conversation
ethanpalm
reviewed
May 29, 2026
ethanpalm
approved these changes
May 29, 2026
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
Minor style cleanup on the recently added workflows pages to keep voice and sentence length consistent with the rest of the docs.
Changes
workflows/reference.mdx— split two 30+ word sentences in Update from code changes and Maintenance workflows.guides/use-workflows.mdx— split a 40-word sentence in Control credit usage into two.workflows/manage.mdx— rephrase passive "must be installed" to active "install" for the Mintlify GitHub App note.Context
Reviewed the workflow pages added in #6023 against the rest of the English docs for second-person voice, active voice, sentence length, heading capitalization (sentence case), and click/select terminology. Headings, voice, and terminology already match the predominant style — only a few long sentences and one passive-voice construction needed adjustment.
Note
Low Risk
Editorial MDX changes only; no runtime, auth, or configuration logic affected.
Overview
Documentation-only copy edits on three workflows-related pages—no product or behavior changes.
In
guides/use-workflows.mdx, the Control credit usage section replaces one long sentence with two shorter ones and adds a contrast between scheduled runs (predictable PR volume) and push-triggered runs (variable month-to-month).In
workflows/reference.mdx, Update from code changes tightens wording for the per-PR trigger (e.g. “opens” instead of “creates,” “code change” instead of “source code pull request”). Maintenance workflows splits a long schedule-vs-trigger sentence and frames the schedule tradeoff explicitly.In
workflows/manage.mdx, the context repositories note switches from passive “must be installed” to imperative install the Mintlify GitHub App.Reviewed by Cursor Bugbot for commit 7bd75ba. Bugbot is set up for automated code reviews on this repo. Configure here.