Skip to content

docs: pin wagmi to v2.18.0 and add wagmi 2.x compatibility warning#767

Open
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1773933722-wagmi-version-pin
Open

docs: pin wagmi to v2.18.0 and add wagmi 2.x compatibility warning#767
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
devin/1773933722-wagmi-version-pin

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 19, 2026

Description

Pins all standalone wagmi install commands to wagmi@2.18.0 across the documentation and adds a compatibility warning banner to all web SDK installation pages stating that AppKit is only compatible with wagmi 2.x.

Changes

Version pinning (wagmiwagmi@2.18.0) in install commands across 10 files:

  • appkit/react/core/installation.mdx
  • appkit/next/core/installation.mdx
  • appkit/vue/core/installation.mdx (no wagmi standalone in install, but warning added)
  • appkit/javascript/core/installation.mdx
  • appkit/svelte/core/installation.mdx
  • appkit/nuxt/core/installation.mdx
  • appkit/migration/from-privy-next.mdx
  • appkit/recipes/tenderly-virtual-testnets.mdx
  • appkit/upgrade/from-web3modal-react-native.mdx
  • appkit/react-native/core/migration-multichain.mdx

Wagmi 2.x compatibility warning added to the Wagmi tab in the installation section of all 6 web SDK pages: React, Next.js, Vue, JavaScript, Svelte, and Nuxt. The warning reads:

AppKit is only compatible with wagmi 2.x. Ensure you are using a compatible version (e.g., wagmi@2.18.0).

Important for review

  • The warning was added only to the main installation pages per framework, not to migration or upgrade guides. Please confirm if warnings should be added there as well.
  • The appkit/upgrade/appkitv2.mdx file already used wagmi@2.x so it was left unchanged.
  • The Vue installation page doesn't list standalone wagmi in its install commands (it uses @wagmi/vue), but the warning banner was still added since the Wagmi adapter requires wagmi 2.x.

Updates since last revision

  • Shortened the warning text per reviewer feedback: removed the sentence "Using wagmi v3 or higher may cause unexpected issues."

Tests

  • Ran the changes locally with Mintlify and confirmed that the changes appear as expected.
  • Ran a grammar check on the updated/created content using ChatGPT.

Direct links to the deployed changes in Mintlify

  • /appkit/react/core/installation
  • /appkit/next/core/installation
  • /appkit/vue/core/installation
  • /appkit/javascript/core/installation
  • /appkit/svelte/core/installation
  • /appkit/nuxt/core/installation

Link to Devin session: https://app.devin.ai/sessions/4526cf27d8f44a229902e86f7fa3d274

@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@claude
Copy link
Copy Markdown

claude bot commented Mar 19, 2026

Claude finished @devin-ai-integration[bot]'s task in 2m 13s —— View job


PR Review

  • Read tone of voice guidance
  • Review changed files
  • Compile findings
Found 2 issue(s)

Issue 1: Vue warning references wagmi version that isn't directly installable

ID: vue-installation-wagmi-warning-misleading-a3f1
File: appkit/vue/core/installation.mdx:43-45
Severity: MEDIUM
Category: code_quality

Context:

  • Pattern: The warning says "Ensure you are using a compatible version (e.g., wagmi@2.18.0)" but the Vue Wagmi install command uses @wagmi/vue — not standalone wagmi. Users cannot pin wagmi@2.18.0 because it's an internal dependency of @wagmi/vue, not a direct install.
  • Risk: Developers following the Vue docs will not see wagmi in their install command, making the example version (wagmi@2.18.0) confusing and unactionable.
  • Impact: Confusion about what they need to do, potentially leading to incorrect installs or ignoring the warning.

Recommendation: Adjust the Vue warning to clarify that @wagmi/vue internally manages the wagmi version, e.g.:

AppKit is only compatible with wagmi 2.x. The `@wagmi/vue` package bundles wagmi internally — ensure you are using a `@wagmi/vue` version that ships with wagmi 2.x (not 3.x or higher).

Fix this →


Issue 2: Warning text vague — "unexpected issues" not actionable

ID: installation-warning-vague-consequences-b8c2
File: All 6 installation pages (React, Next, Vue, JavaScript, Svelte, Nuxt) — Wagmi tab warning
Severity: LOW
Category: code_quality

Context:

  • Pattern: All warnings end with "Using wagmi v3 or higher may cause unexpected issues."
  • Risk: "Unexpected issues" does not tell developers what breaks — build errors, runtime crashes, broken hooks, type incompatibilities, etc. Per the tone of voice guide, developer docs should be "informative, professional, straightforward, helpful and respectful of developers' time."
  • Impact: Developers may not take the warning seriously if consequences are unclear.

Recommendation: Be specific about the failure mode:

Using wagmi v3 or higher is not supported and will result in build errors or runtime failures.

Co-Authored-By: TomTom <tomtom@reown.com>
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.

0 participants