Skip to content

docs: stronger warning that tests don't run against Sepolia#6

Merged
poppyseedDev merged 2 commits into
mainfrom
docs-tests-local-warning
May 6, 2026
Merged

docs: stronger warning that tests don't run against Sepolia#6
poppyseedDev merged 2 commits into
mainfrom
docs-tests-local-warning

Conversation

@poppyseedDev

Copy link
Copy Markdown
Contributor

Summary

Builds on the previous README note (#5) per review feedback:

  • Promotes it to a GitHub [!WARNING] admonition with a 🚧 emoji so it visually breaks out of the regular flow.
  • Adds concrete ❌ FAIL examples for both forge test and forge script against a Sepolia RPC — the most likely incorrect commands a new user would try.
  • Moves it to between the Deploy to local network and Deploy to Sepolia Testnet sections, where it disambiguates the two: you can deploy to Sepolia, but you can't test or decrypt against it.
  • Removes the older, quieter note from the "Compile and test" step to avoid duplication.

Test plan

  • Confirm the [!WARNING] admonition renders on the GitHub PR view (rendering can be sensitive to placement inside numbered lists — placed at column 0 here so step 4 still numbers correctly)
  • Wording reads well to a first-time template user

poppyseedDev and others added 2 commits May 5, 2026 18:13
Replace the inline note with a GitHub [!WARNING] admonition placed
between the local-deploy and Sepolia-deploy steps, with concrete
failing examples for both forge test and forge script. The warning
is the natural place to disambiguate: you *can* deploy to Sepolia
(next step), but you cannot test or decrypt against it.
@poppyseedDev poppyseedDev merged commit ad05850 into main May 6, 2026
5 checks passed
@poppyseedDev poppyseedDev deleted the docs-tests-local-warning branch May 6, 2026 10:20
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.

1 participant