diff --git a/.vale.ini b/.vale.ini index dcf230e6f..75200f8dd 100644 --- a/.vale.ini +++ b/.vale.ini @@ -45,5 +45,7 @@ Microsoft.Hyphens = NO Microsoft.We = NO Microsoft.Avoid = NO - +# Changelog entries use time-relative terms ("You can now...") by convention +[**/changelog/*.mdx] +FernStyles.Current = NO diff --git a/.vale/styles/FernStyles/Acronyms.yml b/.vale/styles/FernStyles/Acronyms.yml index e444fef52..78d66cfde 100644 --- a/.vale/styles/FernStyles/Acronyms.yml +++ b/.vale/styles/FernStyles/Acronyms.yml @@ -110,3 +110,18 @@ exceptions: - ISO - AUTO - SHA + - GTM + - PATCH + - DELETE + - HEAD + - OPTIONS + - PEM + - HMAC + - MITM + - TOML + - ORM + - CORS + - CIDR + - NaN + - EOF + - CRUD diff --git a/.vale/styles/FernStyles/Current.yml b/.vale/styles/FernStyles/Current.yml index 017088720..8fe96c4d7 100644 --- a/.vale/styles/FernStyles/Current.yml +++ b/.vale/styles/FernStyles/Current.yml @@ -14,4 +14,3 @@ tokens: - soon - latest - upcoming - - old \ No newline at end of file diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml index 50eced3e8..752158924 100644 --- a/.vale/styles/FernStyles/Headings.yml +++ b/.vale/styles/FernStyles/Headings.yml @@ -91,3 +91,30 @@ exceptions: - BCP - ISO - Replay + - Fern Replay + - Playground + - API Playground + - Dashboard + - Fern Dashboard + - Editor + - Fern Editor + - Writer + - Fern Writer + - Ask Fern + - Explorer + - Autorelease + - Bitbucket + - NuGet + - Crates + - Terraform + - Gradle + - Swagger + - Webpack + - Vite + - Vercel + - Netlify + - Cloudflare + - PostgreSQL + - Redis + - Stripe + - Twilio diff --git a/.vale/styles/FernStyles/Hedges.yml b/.vale/styles/FernStyles/Hedges.yml new file mode 100644 index 000000000..917605531 --- /dev/null +++ b/.vale/styles/FernStyles/Hedges.yml @@ -0,0 +1,19 @@ +extends: existence +message: "Avoid hedge words and filler like '%s'. Prefer direct statements." +level: suggestion +ignorecase: true +tokens: + - simply + - just + - make sure you + - make sure to + - be sure to + - you'll want to + - you'll need to + - you may want to + - you might want to + - please note that + - it is important to note + - it should be noted + - note that + - keep in mind