Skip to content

Update Vale configuration: reduce false positives and add hedge word rule #5590

Merged
devalog merged 1 commit into
mainfrom
fern/vale-config-analysis
May 21, 2026
Merged

Update Vale configuration: reduce false positives and add hedge word rule #5590
devalog merged 1 commit into
mainfrom
fern/vale-config-analysis

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 21, 2026

Summary

Updates the Vale linting configuration based on analysis of ~25 docs PRs from the past month. Reduces false-positive noise and adds a new rule aligned with the AGENTS.md voice guidelines.

Changes

FernStyles/Current.yml

  • Removed old from the time-relative terms list — it was false-positiving on redirect examples (/old-path) and migration docs

.vale.ini

  • Added [**/changelog/*.mdx] section that disables FernStyles.Current for changelog entries, since changelogs legitimately use terms like "You can now..." and "latest"

FernStyles/Acronyms.yml

  • Added 15 missing acronyms: GTM, PATCH, DELETE, HEAD, OPTIONS, PEM, HMAC, MITM, TOML, ORM, CORS, CIDR, NaN, EOF, CRUD

FernStyles/Headings.yml

  • Added Fern product names and common third-party names: Playground, Dashboard, Editor, Writer, Ask Fern, Explorer, Autorelease, Bitbucket, NuGet, Terraform, Gradle, Swagger, Webpack, Vite, Vercel, Netlify, Cloudflare, PostgreSQL, Redis, Stripe, Twilio, and more

FernStyles/Hedges.yml (new)

  • New rule that flags hedge words and filler phrases called out in AGENTS.md: simply, just, make sure you, be sure to, you'll want to, please note that, keep in mind, etc.
  • Set to suggestion level so it's educational, not blocking

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 21, 2026 18:39
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 21, 2026

Requested by: devin
Slack thread: View conversation

@github-actions
Copy link
Copy Markdown
Contributor

@devalog devalog merged commit f521cb3 into main May 21, 2026
5 of 6 checks passed
@devalog devalog deleted the fern/vale-config-analysis branch May 21, 2026 19:40
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