Add Hardhat Upgrades docs for Hardhat 3#147
Add Hardhat Upgrades docs for Hardhat 3#147ericglau wants to merge 8 commits intoOpenZeppelin:mainfrom
Conversation
|
Doc previews of Hardhat 3 related content:
Hardhat 2 content are moved to "Previous Versions" under here: |
Hardhat 3 documentation structure and coverageThis PR updates the Upgrades Plugins docs for the Hardhat 3 release. The documentation is organized around three user paths:
Coverage goalsThe main goal is to make the Hardhat 3 path feel like the default path for new users, while keeping the Hardhat 2 path easy to find for existing projects. The current pages explain the new Hardhat 3 setup model: explicit plugin registration, creating an The migration guide is meant to be practical rather than exhaustive: it highlights the user-visible breaking changes and gives before/after examples for config, imports, scripts, tasks, tests, and source code verification. The Solidity-test section is included as an optional path for users who want to use Hardhat 3 Solidity tests with Defender documentation remains in place, with Hardhat 3 users directed back to the new factory/connection pattern where needed. Assumptions to sanity-check
Relevant files:
|
Summary
Adds Hardhat 3 documentation for the Hardhat Upgrades plugin (
@openzeppelin/hardhat-upgrades4.0.0, to be released). The existing Hardhat 2 docs are preserved as legacy under/upgrades-plugins/hardhat-2/*with an "Outdated Version" banner. Pre-existing URLs (/upgrades-plugins/hardhat-upgrades,/upgrades-plugins/api-hardhat-upgrades) remain live and now describe Hardhat 3 — no redirects. Also adds a migration guide to/upgrades-plugins/migrate-from-hardhat-2and adds nav entries.Type of Change
Related Issues
OpenZeppelin/openzeppelin-upgrades#1191
OpenZeppelin/openzeppelin-upgrades#1241
OpenZeppelin/openzeppelin-foundry-upgrades#121
Checklist
pnpm run buildpnpm run checkAdditional Notes