Skip to content

docs: align heading with Vale word list (vs. → versus)#6045

Merged
ethanpalm merged 1 commit into
mainfrom
mintlify/7738d886
Jun 1, 2026
Merged

docs: align heading with Vale word list (vs. → versus)#6045
ethanpalm merged 1 commit into
mainfrom
mintlify/7738d886

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 1, 2026

Summary

Replace vs. with versus in one navigation guide heading to match the Mintlify Vale word list.

Changes

  • guides/navigation.mdx: "Missing pages vs. navigation problems" → "Missing pages versus navigation problems"

Context

Full audit of 221 English MDX files against the repo's writing standards (.cursor/rules/writing-standards.mdx) and Vale rules (.vale/styles/Mintlify/*) for:

  • Second vs. third person voice
  • Active vs. passive voice
  • Sentence-case headings
  • Long sentences (>30 words)
  • Inconsistent terminology (click/press/select/choose)
  • Vale WordList substitutions (vs., in order to, click on, Email, WiFi, etc.)

The docs are largely consistent. The only clear deviation from the enforced word list was vs. in this heading. Other near-matches were intentional (e.g., In order to quoted as a bad-style example in guides/style-and-tone.mdx, regex referencing a literal IdP UI label in dashboard/sso.mdx, first-person we/our in support/legal/migration pages which the FirstPerson rule allows). Long sentences are within acceptable limits.


Note

Low Risk
Documentation-only wording in a heading; no product, API, or runtime behavior changes.

Overview
Updates a single H3 in guides/navigation.mdx so the heading uses versus instead of vs., matching the Mintlify Vale word list and the repo’s writing standards. No navigation guidance or body copy changes.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jun 1, 2026, 9:40 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
smartac 🟢 Ready View Preview Jun 1, 2026, 9:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview Jun 1, 2026, 9:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ethanpalm ethanpalm merged commit ad1d2c0 into main Jun 1, 2026
6 checks passed
@ethanpalm ethanpalm deleted the mintlify/7738d886 branch June 1, 2026 22:51
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.

2 participants