Skip to content

Conversation

@m4sterbunny
Copy link
Contributor

@m4sterbunny m4sterbunny commented Jan 8, 2026

Adding rules following review round


Note

Improves CI efficiency and expands Vale rules for clearer, consistent docs.

  • CI: action.yml now uses tj-actions/changed-files to pass only changed doc paths to errata-ai/vale-action, adds glob-based FILEPATHS defaults, pins action SHAs, and runs Vale conditionally.
  • Styles: Extends CaseSensitive-Substitution.yml with offchain variants and capitalization fixes for MetaMask, Embedded Wallets, Mastercard, WalletConnect, Shamir's, and Polkadot.
  • Vocab: Updates accept.txt (adds [eE]thers, [vV]ue, [wW]agmi, [bB]iometrics, [bB]ivariate) and project-words.txt (adds @solana/web3.js, capitalized Polkadot, Shamir's; removes lowercased duplicates like ethers, polkadot, shamir, wagmi).
  • Docs tooling: Adds .cursorrules to constrain modifications to styles/config/ and styles/Consensys/.

Written by Cursor Bugbot for commit 8ecb673. This will update automatically on new commits. Configure here.

files: ${{ inputs.FILEPATHS }}
separator: ","
vale_flags: "--config .github-actions/docs-spelling-check/.vale.ini --glob={*.md,*.mdx}"
files: ${{ steps.changed-files.outputs.all_changed_files }}
Copy link

Choose a reason for hiding this comment

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

Removed separator may break vale-action file parsing

Medium Severity

The separator parameter was removed from the vale-action configuration, but the input format has changed from comma-separated paths to newline-separated file paths (via output_separator: '\n' from changed-files). The old configuration explicitly set separator: "," to tell vale-action how to parse multiple files. Without this parameter, vale-action may not correctly parse the newline-separated all_changed_files output, potentially causing the linter to fail or process files incorrectly.

Fix in Cursor Fix in Web

'Walletconnect': '"WalletConnect"'
# Shamir's - enforce proper capitalization
shamir: "Shamir's"
"shamir's": "Shamir's"
Copy link

Choose a reason for hiding this comment

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

Missing substitution rule for capitalized "Shamir" without apostrophe

Low Severity

The substitution rules only cover shamir and shamir's (lowercase forms), but with ignorecase: false, these won't match Shamir (capital S, no apostrophe). The project-words.txt only ignores Shamir's. If someone writes "Shamir" as a proper noun (e.g., referencing Adi Shamir), it would be flagged as a spelling error since there's no substitution rule like Shamir: "Shamir's" to handle this capitalized form.

Fix in Cursor Fix in Web

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