Skip to content

docs: add getting-started tutorial — deploy a contract to OP Sepolia#21607

Draft
sbvegan wants to merge 1 commit into
developfrom
soyboy/docs/deploy-a-contract
Draft

docs: add getting-started tutorial — deploy a contract to OP Sepolia#21607
sbvegan wants to merge 1 commit into
developfrom
soyboy/docs/deploy-a-contract

Conversation

@sbvegan

@sbvegan sbvegan commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

New getting-started tutorial for app developers at docs/public-docs/app-developers/tutorials/deploy-a-contract.mdx, plus a nav entry to make it discoverable.

The app-developer docs had no first-class, learning-oriented walkthrough for deploying a contract to an OP Stack chain. Every existing app-dev tutorial (bridging, interoperability, transactions) assumes the reader has already deployed something. This page fills that gap: install Foundry → scaffold a project with a Greeter contract → configure the OP Sepolia RPC and a funded account → deploy with forge create → read/write with cast → view the result on a block explorer.

  • Audience: app developers taking their first step on the OP Stack.
  • Diátaxis quadrant: tutorial (declared in frontmatter).
  • Grounding: every network value is sourced from OP's own docs — OP Sepolia chain ID 11155420, public RPC https://sepolia.optimism.io, and the Superchain Faucet, per connecting-to-op.mdx and rpc-providers.mdx. The Greeter contract and the forge create / cast call / cast send patterns match the existing message-passing.mdx tutorial.

Files changed

File Change
docs/public-docs/app-developers/tutorials/deploy-a-contract.mdx New tutorial page (diataxis: tutorial).
docs/public-docs/docs.json Adds the page as the first entry in the App Developers → Tutorials group.

What to review

Source-derived accuracy (needs an app-dev / DevRel eye):

  1. The end-to-end flow (forge createcast codecast call/cast send) — confirm the commands run cleanly against public OP Sepolia today, especially rate-limit behavior on https://sepolia.optimism.io.
  2. Faucet link and flow — confirm the Superchain Faucet still dispenses OP Sepolia ETH to a pasted address.

Judgment calls:

  • Placement at app-developers/tutorials/deploy-a-contract.mdx (tutorials root, not a sub-group) and slug deploy-a-contract.
  • Nav position: first in the Tutorials group, so the getting-started path leads.
  • Explorer verification is described as optional and links to the block explorers page rather than hardcoding a forge verify-contract invocation (verifier/API not grounded here).

Out of scope

  • Contract source verification on the explorer (mentioned as an optional next step, not walked through).
  • Framework alternatives (Hardhat, Remix) — this tutorial commits to one runnable path (Foundry) to keep it learning-oriented; the Building apps guide covers the stack landscape.

Test plan

  • mintlify dev renders the page and the updated sidebar without errors.
  • Internal links resolve (lint reported 7/7 resolved at commit time).
  • docs.json parses as valid JSON (verified at commit time).
  • An app-dev engineer confirms the deploy/interact commands work against public OP Sepolia.

Tracks ethereum-optimism/solutions#801 · part of the Diátaxis docs-structure backlog (ethereum-optimism/solutions#790). Context: projects/docs-improver/README.md.

🤖 Drafted by the docs-improver agent — review before merge.

🤖 Generated with Claude Code

…ract to OP Sepolia

Adds a learning-oriented tutorial (Diátaxis `tutorial` quadrant) that walks an
app developer end-to-end through deploying their first contract to OP Sepolia
with Foundry: install → project + Greeter contract → configure the OP Sepolia
RPC and a funded account → deploy with `forge create` → read/write with `cast`
→ view on the block explorer. Every network parameter, RPC endpoint, and faucet
link is grounded in OP's own docs; the Greeter contract and `forge`/`cast`
patterns match the existing interoperability tutorial.

Wires the page into the App Developers → Tutorials nav as the first entry.

Tracks ethereum-optimism/solutions#801

Co-Authored-By: Claude <noreply@anthropic.com>
@sbvegan sbvegan added M-docs Meta: documentation related docs-improver Opened by the docs-improver agent size:L docs-improver size band source:benchmark docs-improver source lane labels Jul 1, 2026
@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Optimism-Docs 🟢 Ready View Preview Jul 1, 2026, 6:13 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-improver Opened by the docs-improver agent M-docs Meta: documentation related size:L docs-improver size band source:benchmark docs-improver source lane

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant