fix: add --broadcast to forge create examples and fix broken links#138
Open
erhnysr wants to merge 2 commits into
Open
fix: add --broadcast to forge create examples and fix broken links#138erhnysr wants to merge 2 commits into
erhnysr wants to merge 2 commits into
Conversation
- deploy-contracts.md: forge create requires --broadcast (Foundry v1.0+) to actually send the deploy tx; without it the command only simulates - deploy-contracts.md: fix API key link text to match /apidashboard URL - minikit-to-farcaster/mapping.md: replace dead NOTIFICATIONS.md links with the Farcaster Mini App notifications guide
Collaborator
🟡 Heimdall Review Status
|
docs.base.org/ai-agents/guides/wallet-setup does not exist (it resolves to the Base MCP quickstart page, and no wallet-setup guide is listed in docs.base.org/llms.txt). Point users who need a wallet to the Base App (https://base.app), where they can create a Base Account and get an address.
Author
|
All four fixes were verified rather than assumed:
Docs-only changes, no behavioral/spec impact. |
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
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.
What
Four small, verified doc fixes in
build-on-base:forge createwon't deploy without--broadcast—references/deploy-contracts.mdSince Foundry v1.0,
forge createonly simulates unless--broadcastis passed. The testnet and mainnet examples were missing it, so following them verbatim on a current Foundry prints a successful-looking result but never sends the deploy transaction. Added--broadcastto both commands.Broken
NOTIFICATIONS.mdlinks —references/migrations/minikit-to-farcaster/mapping.mdThe
useNotificationsection linked toNOTIFICATIONS.mdtwice, but no such file exists anywhere in the repo. Replaced both with the Farcaster Mini App notifications guide (https://miniapps.farcaster.xyz/docs/guides/notifications).Link text / URL mismatch —
references/deploy-contracts.mdThe API key step's link text said
basescan.org/myapikey/etherscan.io/myapikeywhile the URLs pointed to/apidashboard. Updated the text to match the (current) URLs.Broken wallet-setup link —
references/agents/register.mdhttps://docs.base.org/ai-agents/guides/wallet-setupdoes not exist as a wallet guide — it resolves to the Base MCP quickstart page, and no wallet-setup page is listed indocs.base.org/llms.txt. Since the step is for a user who has no wallet, pointed them to the Base App (https://base.app) where they can create a Base Account and obtain an address.Why
Each is an objectively verifiable error a reader would hit directly — a deploy command that silently no-ops, dead links, and a link whose destination doesn't match its promised content. Docs-only, no behavioral/spec changes.
Testing
NOTIFICATIONS.mddoes not exist in the repo.--broadcastreference existed in the skill.docs.base.org/ai-agents/guides/wallet-setupserves MCP-connection content (not wallet setup) and that no wallet-setup page is listed inllms.txt; confirmedhttps://base.appis the live Base Account entry point.