Skip to content

Linter fixes#2873

Open
alexandratran wants to merge 11 commits intomainfrom
vale-fixes
Open

Linter fixes#2873
alexandratran wants to merge 11 commits intomainfrom
vale-fixes

Conversation

@alexandratran
Copy link
Copy Markdown
Contributor

@alexandratran alexandratran commented Apr 18, 2026

Description

  • Vale was previously misconfigured and not running on any doc files. This PR updates the config to ensure the CI runs on all changed lines in md/mdx files. Reviewdog will report warnings and errors. Vale updated in update docs-spelling-check Consensys/github-actions#119 to reflect latest MetaMask conventions and balance strictness; we can continue to update if Vale introduces too much friction in new PRs.
  • Fix most significant/common Vale errors in metamask-connect, smart-accounts-kit, and snaps folders. embedded-wallets may have significant remaining errors.
  • Update Prettier CI to only run on changed files. In case contributors bypass the Prettier pre-commit hook and CI for some reason, other PRs won't be blocked by unrelated Prettier issues.
  • Fix Prettier issues + ignore generated SAK glossary

Preview

Checklist

  • If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
  • If this PR updates or adds documentation content, it has received an approval from a technical writer.

External contributor checklist

  • I've read the contribution guidelines.
  • I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

Note

Medium Risk
Medium risk because it changes CI behavior (Prettier now checks only changed files and spelling no longer constrains FILEPATHS), which could unintentionally skip formatting/spelling enforcement or change what gets validated.

Overview
Docs linting/formatting behavior is adjusted and a batch of Vale-driven copy/format fixes are applied. CI now uses tj-actions/changed-files to run Prettier only against relevant changed files (with full git history via fetch-depth: 0) and updates the spelling job checkout depth while removing the explicit FILEPATHS restriction.

Documentation updates standardize terminology (notably sign-in/sign-out, onchain/offchain, and Wallet Standard/Adapter casing), fix typos/punctuation, improve alt text/code formatting, and update multiple internal links from .md to .mdx. Generated Smart Accounts Kit glossary output is now treated as generated-only (.gitignore/.prettierignore), and the glossary generator script drops the Prettier formatting step.

Reviewed by Cursor Bugbot for commit e306d0b. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
metamask-docs Ready Ready Preview, Comment Apr 20, 2026 7:22pm

Request Review

Comment thread .github/workflows/ci.yml Fixed
@alexandratran alexandratran marked this pull request as ready for review April 20, 2026 19:18
@alexandratran alexandratran requested review from a team as code owners April 20, 2026 19:18
@alexandratran alexandratran changed the title Vale fixes Linter fixes Apr 20, 2026
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