Let domain terms and protocol acronyms through Vale#37
Merged
Conversation
After applying the writing-docs skill across the 14-PR consolidation, the remaining ~300 Vale violations were all in three categories of domain false positives, not real style issues: - Spelling on legitimate domain vocabulary (IHook, ICondition, captureAuthorizer, authCapture, escrowed, pluggable, multisig, timelock, ...). - Microsoft.HeadingAcronyms on every reference page that headlines a protocol acronym (ERC-3009, EIP-712, EIP-6492, BUSL-1.1, JSON-RPC, CDP, DAO). - Microsoft.Terms swapping "agent" -> "personal digital assistant", which is wrong for ERC-8004 on-chain agents. - proselint.Typography suggesting the multiplication sign in place of every `0x` hex literal. Vocab additions (60+ entries), grouped by intent: - Contract interfaces (IHook, ICondition, IRecorder, IPaymentOperator) - Protocol concepts (authCapture, captureAuthorizer, capturable, combinators, escrowed, permissionless, pluggable, composability, micropayments, gasless, terminalize, reentrancy, refundability, timelock, multisig, mempool, calldata) - SDK identifiers (operatorConfig, maxAmount, responseBody, paymentPayload, newCount, existingCount, escrowPeriod, txHashes, codehashes) - Tooling and runtime (npm, npx, pnpm, bunx, dlx, tsx, dotenv, stdout, stderr, mkdir, Boolean, namespace, testnet, devnet, Mintlify, subgraph, gwei, txns, const) - Standards and acronyms (APIs, ABIs, UIs, EVMs, dApps, CIDs) - Ecosystem (Uniswap, Coinbase, Fireblocks, Flashbots, Solana, Solady, Spearbit, Ownable, Aave) Rule disables in .vale.ini, each with rationale in-place: - Microsoft.HeadingAcronyms = NO (no allowlist mechanism, every reference heading triggers it) - Microsoft.Terms = NO (ERC-8004 agent terminology) - proselint.Typography = NO (no code/identifier context awareness) Pairs with the writing-docs cleanup landing in PR #35. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
vraspar
approved these changes
Jun 1, 2026
vraspar
left a comment
vraspar
left a comment
Contributor
There was a problem hiding this comment.
Approving — clean config-tuning PR.
- 60+ vocab additions are all real domain terms (Solidity interfaces, protocol concepts, SDK identifiers, tooling, standards, ecosystem)
- 3 rule disables each carry a clear inline rationale:
Microsoft.HeadingAcronymshas no allowlist mechanism so wholesale-disable is the only path for protocol acronyms (ERC-3009, EIP-712, BUSL-1.1, etc.);Microsoft.Termsswaps "agent" wrongly for ERC-8004;proselint.Typographyfires on every0xhex literal with no code-context awareness - Purely additive (+103 / −0), CI green, no conflicts with PR #35
Merge order doesn't matter — independent of PR #35 by design.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
After applying the writing-docs skill across PR #35's 14-PR consolidation, the remaining ~300 Vale hits were all false positives on x402r-specific vocabulary, protocol acronyms, hex literals, and the Microsoft "agent" terminology swap. This PR teaches Vale about the domain so prose-quality signal isn't drowned by false positives.
Microsoft.HeadingAcronyms = NO— protocol acronyms (ERC-3009,EIP-712,EIP-6492,BUSL-1.1,JSON-RPC,CDP,DAO) are the canonical names. The rule has no allowlist mechanism.Microsoft.Terms = NO— itsagent → personal digital assistantmapping is wrong for ERC-8004 on-chain agents and the broader crypto/AI-agents ecosystem.proselint.Typography = NO— flags every0xhex literal as wanting the×symbol. No code/identifier context awareness.Each disable has its rationale inline in
.vale.ini, matching the existing comment style.Why this is a separate PR from #35
PR #35 is content-only edits to clear actionable prose violations. This is config-tuning that affects what fires going forward across the whole repo. Splitting the two keeps review focused and lets either land independently.
Test plan
cd docs && vale --no-exit .— confirm the three disabled rules no longer firenpx mint dev— no rendering regressions🤖 Generated with Claude Code