Skip to content

Fix Vale style warnings from PRs merged in the last week#5806

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/vale-audit-1778771632
Open

Fix Vale style warnings from PRs merged in the last week#5806
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/vale-audit-1778771632

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 14, 2026

Summary

Applies Vale style fixes to English documentation files modified by PRs merged to main in the last week.

Changes

  • ai/mintlify-mcp.mdx: Replaced "regex" with "regular expression" (WordList).
  • guides/automate-agent.mdx: Changed heading "What you will build" to "What you'll build" to avoid will (Will).

Audit scope

Reviewed the English .mdx files touched by the 33 PRs merged into main since 2026-05-07, focusing on files changed after the previous Vale audit (#5690). Ran the .vale/styles/Mintlify rules (WordList, Will, EmDash, Latin, Spelling, Ellipses, Slang, LyHyphens, OptionalPlurals, Periods, AMPM, Ordinal, Headings, HeadingPunctuation, OxfordComma) against the working tree.

Warnings noted but not fixed (need human review)

The following matches were detected but not changed automatically. They're either false positives that the Vale config tolerates, or context-dependent edits that risk breaking meaning. Flagging for reviewer:

  • agent/slack.mdx, ai/mintlify-mcp.mdx, deploy/export.mdx, workflows/index.mdx, others — EmDash in list items and tables. Lines like - **\read`** — Fetch the full MDX of any page on the session branch.` use spaced em-dashes after bold/code list markers. The previous Vale audit PR (Fix Vale style warnings from PRs merged in the last week #5690) did not rewrite these patterns, so they appear to be acceptable in lists/tables. Skipped to avoid churn; reviewer can confirm.
  • dashboard/sso.mdx:138WordList "regex". Appears inside an Okta UI screenshot description (| Matches regex |) where "Matches regex" is the literal Okta UI label. Changing it would misrepresent the product UI. Left as-is.
  • dashboard/sso.mdx:2,3WordList "sign-on". Pattern matched within Single sign-on (SSO) (title and description), which is already the recommended form. False positive from the substitution pattern matching the suffix.
  • create/changelogs.mdx:139WordList "Email" inside link text [Email](...). Link text is the visible label of a link to an Email tool integration. Changing capitalization of link text would affect rendered title casing in the bullet list. Left for human judgment.
  • Heading capitalization warnings in assistant/configure.mdx (Enable the assistant on the Hobby plan), dashboard/sso.mdx (Google Workspace with SAML), deploy/github.mdx (GitHub Enterprise with IP allowlists), deploy/route53-cloudfront.mdx (Connect with Route 53), and guides/automate-agent.mdx (GitHub Actions ...). All flagged words are proper product/plan names (Hobby plan, Google Workspace, GitHub Enterprise, GitHub Actions, Route 53), which .vale/styles/Mintlify/Headings.yml already supports via exceptions/vocabulary. Skipped.
  • changelog.mdx warnings. The .vale.ini excludes changelog.mdx from Mintlify style checks (BasedOnStyles = ""), so no fixes are required there.
  • OxfordComma matches (200+) — almost all are false positives from list-item phrasing or table cells where the rule's sentence-scope regex over-matched. Left for reviewer to spot-check.

If reviewers want any of the above resolved, please leave a suggestion on the relevant line and I'll apply it.


Note

Low Risk
Low risk documentation-only edits; main impact is potential deep-link changes due to updated section id attributes in translated guides.

Overview
Updates documentation copy to satisfy Vale style checks: replaces “regex” with “regular expression” in ai/mintlify-mcp.mdx and changes the English guide heading to What you'll build.

Also normalizes the corresponding section anchor id in the ES/FR/ZH automate-agent.mdx guides from what-you-will-build to what-youll-build, which may affect existing in-page links.

Reviewed by Cursor Bugbot for commit 18d497f. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 14, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 14, 2026, 3:20 PM

Generated-By: mintlify-agent
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.

0 participants