Skip to content

Vale rules #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
m4sterbunny wants to merge 10 commits into from
Closed

Vale rules #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
02fc1bf
attempted fix to lint only changed files
m4sterbunny Jan 30, 2026
c2d1847
filtering to md and mdx to please bot
m4sterbunny Jan 30, 2026
fe8daa0
specifying two separators to please bot, making it new line to assist…
m4sterbunny Jan 30, 2026
830c184
adds rules
m4sterbunny Feb 12, 2026
834c970
fix merge conflicts
m4sterbunny Feb 12, 2026
6c6b636
fix to pls bot; file separator
m4sterbunny Feb 12, 2026
273f1c4
fix to pls bot; alphabetical
m4sterbunny Feb 12, 2026
e1f2ca0
run vale on this repo
m4sterbunny Feb 12, 2026
7c45e05
clean out pr to style only
m4sterbunny Feb 16, 2026
94cf93f
restore pages
m4sterbunny Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/spelling.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Spell check

on:
pull_request:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read

jobs:
vale:
name: Vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Run Vale
uses: ./docs-spelling-check
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.DS_Store
.idea
.idea
docs-spelling-check/styles/Microsoft/
docs-spelling-check/styles/proselint/
docs-spelling-check/styles/write-good/
3 changes: 3 additions & 0 deletions docs-spelling-check/.vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ Microsoft.Contractions = NO
# Microsoft.GeneralURL is not relevant
Microsoft.GeneralURL = NO

# Allow "agent" variants despite Microsoft.Terms preference
Microsoft.Terms.Ignore = (?i)\bagents?\b
Copy link

@cursor cursor bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Microsoft.Terms.Ignore may not be valid Vale config

Medium Severity

Microsoft.Terms.Ignore does not appear to be a documented Vale configuration key. The .Ignore suffix is supported for the built-in Spelling rule (to reference dictionary files), but Microsoft.Terms is a substitution-type rule which only supports exceptions and vocab in its YAML definition. Vale will likely silently ignore this setting, meaning "agent" variants won't actually be excluded from Microsoft.Terms checks. The vocabulary accept.txt or the rule's exceptions array would be the standard way to achieve this.

Fix in Cursor Fix in Web


# Allows Microsoft.Adverbs to take precedence
Microsoft.Very = NO

Expand Down
1 change: 1 addition & 0 deletions docs-spelling-check/styles/Consensys/Headings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ exceptions:
- Ethers.js
- EthSigner
- EVM
- Embedded Wallets
Copy link

@cursor cursor bot Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heading exception breaks alphabetical list ordering

Low Severity

Embedded Wallets is appended after EVM but the exceptions list is alphabetically ordered. Since "Em" sorts before "EO"/"ER"/"ET"/"EV", this entry belongs between Electron and Emmet to maintain the established ordering convention.

Fix in Cursor Fix in Web

- FAQs
- Flask
- Go
Expand Down
6 changes: 0 additions & 6 deletions docs-spelling-check/styles/Microsoft/Very.yml
View file
Open in desktop

This file was deleted.

3 changes: 3 additions & 0 deletions docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ InfluxDB
Infura
[iI]nterlockUrl
IntraLayer
[iI]nviter(?:'s)?
Irys
Jasypt
JMeter
Expand Down Expand Up @@ -158,6 +159,7 @@ paramStructure
[pP]asswordless
Pegasys
[pP]ermission(?:ing|ed)?
[pP]imlico(?:'s)?
[pP]repend(?:s|ing|ed)?
[Pp]recompile[s]?
Photoshop
Expand Down Expand Up @@ -242,6 +244,7 @@ USB Armory Mk II
Vercel
Vertx
vCPU[s]?
[vV]iem(?:'s)?
[vV]ue
[wW]agmi
[wW]eb3
Expand Down
Loading