Skip to content

Fix Vale style warnings in recently changed files#5090

Merged
ethanpalm merged 2 commits intomainfrom
mintlify/vale-fixes-1775143546
Apr 2, 2026
Merged

Fix Vale style warnings in recently changed files#5090
ethanpalm merged 2 commits intomainfrom
mintlify/vale-fixes-1775143546

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 2, 2026

Summary

Fixes Vale style warnings found in English MDX files changed by PRs merged in the last week.

Changes

File Line Rule Before After
deploy/ghes.mdx 197 Headings (sentence case) ## FAQ and Troubleshooting ## FAQ and troubleshooting
deploy/ghes.mdx 233 Will (avoid future tense) "The app will need to be re-approved" "The app needs to be re-approved"
create/image-embeds.mdx 179 Headings (sentence case) ## iframes ## Iframes
create/changelogs.mdx 136 WordList ("Email" → "email") [Email](...) via Zapier [email](...) via Zapier

Skipped (needs human review)

File Line Rule Text Reason
dashboard/sso.mdx 138 WordList ("regex" → "regular expression") "Matches regex" in Okta config table This mirrors the Okta UI label. Changing it could make instructions inaccurate.

Methodology

Scanned all English .mdx files changed by 50 PRs merged between March 27 – April 2, 2026. Checked against all Vale warning-level rules (Ellipses, FirstPerson, HeadingPunctuation, Headings, OxfordComma, Ranges, Spelling, Will, WordList). Content inside code blocks, inline code, frontmatter, JSX components, and HTML tags was excluded per the Vale configuration.


Note

Low Risk
Low risk documentation-only edits (heading capitalization and minor wording) with no behavioral or configuration changes.

Overview
Resolves Vale/style warnings across a few MDX docs by adjusting heading sentence case (e.g., FAQ and troubleshooting, Iframes) and tightening phrasing to avoid future tense.

Also clarifies wording in create/changelogs.mdx around page modes hiding navigation elements and how RSS entries exclude non-Markdown content.

Written by Cursor Bugbot for commit fc7e787. This will update automatically on new commits. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 2, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 2, 2026, 3:28 PM

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm ethanpalm merged commit 58c9ad4 into main Apr 2, 2026
5 checks passed
@ethanpalm ethanpalm deleted the mintlify/vale-fixes-1775143546 branch April 2, 2026 20:17
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