fix(docs): misleading dry run description in deploy-on-base
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Open docs/base-chain/quickstart/deploy-on-base.mdx and review the Step 1 deployment instructions and the referenced forge commands. Update the wording or command so it no longer presents forge create without --broadcast as a simulation, then verify the page clearly explains what happens without broadcasting and how the dry run should work.
Written by the indexing model from the issue text.
Description
Path: /base-chain/quickstart/deploy-on-base
Page: https://docs.base.org/base-chain/quickstart/deploy-on-base
File: docs/base-chain/quickstart/deploy-on-base.mdx
Description
Step 1 of the "Deploy Your Contracts" section describes an optional dry run, but the explanation is misleading.
Current text:
(Optional) First, perform a dry run to simulate the deployment and verify everything is configured correctly:
forge create ./src/Counter.sol:Counter --rpc-url $BASE_SEPOLIA_RPC_URL --account deployerThis performs a simulation without broadcasting the transaction to the network.
This is inaccurate. Running forge create without --broadcast does not perform a simulation — it simply does nothing (no transaction is sent, no output confirms a simulated result). Foundry’s actual dry-run/simulation tool is forge script with the --dry-run flag, not forge create without --broadcast.
The current wording may confuse readers into thinking they have verified their setup when they have not.
Suggested fix
Either:
- Remove the misleading "dry run" step and clarify that omitting
--broadcastsimply prevents deployment, or - Replace with the correct Foundry simulation approach using
forge script --dry-run
Example clearer wording:
To deploy your contract, run the following command. The
--broadcastflag is required to actually send the transaction. Without it, Foundry does not submit anything to the network.
- Dominant language
- JavaScript
- Stars
- 337
- Forks
- 798
- Avg merge
- 7h 24m
- Merged PRs (30d)
- 51
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from base/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·
-
client-controller-update ta-bot-triage team-money-movement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
MetaMask/metamask-mobile#36594 ·