Skip to content

docs: tighten style in workflows pages#6032

Merged
ethanpalm merged 2 commits into
mainfrom
mintlify/995f895f
May 29, 2026
Merged

docs: tighten style in workflows pages#6032
ethanpalm merged 2 commits into
mainfrom
mintlify/995f895f

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 29, 2026

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.

Comment thread workflows/reference.mdx Outdated
@ethanpalm ethanpalm merged commit d9ee99c into main May 29, 2026
5 checks passed
@ethanpalm ethanpalm deleted the mintlify/995f895f branch May 29, 2026 19:12
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 29, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🔴 Failed May 29, 2026, 7:27 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant