docs: add op-supernode how-to page#21837
Open
claude[bot] wants to merge 2 commits into
Open
Conversation
Add a net-new end-to-end setup how-to for op-supernode (node-operators/guides/configuration/supernode-setup.mdx): build the binary, wire each chain's engine API, start the process, and verify every chain is syncing. Adds the page to the Node Operators > Guides > Configuration nav group and cross-links it from the existing supernode configuration guide. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Fix blob-archiver anchor: the heading in node-operators/guides/management/blobs.mdx is "Configuring a blob archiver", so the anchor is #configuring-a-blob-archiver.
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
1 participant
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.
Requested by Matthew Cruz · Slack thread
Before: a node operator searching the docs for how to actually stand up op-supernode found only the configuration recommendations (
node-operators/guides/configuration/supernode.mdx), the flag catalogue (node-operators/reference/op-supernode-config.mdx), and the explainer (op-stack/interop/supernode.mdx) — no page carried the end-to-end procedure: get the binary, wire the engine API/JWT for each chain, start the process, and verify every chain is syncing. After: a net-new how-to atnode-operators/guides/configuration/supernode-setup.mdx(diataxis: how-to) walks that full path — build from source at the pinned release tag, JWT secret and engine-API wiring, a complete starter launch command, and a five-step verification (heartbeat logs,heartbeat_check,supernode_syncStatus, per-chainoptimism_syncStatusunder the/<chainID>/prefix, and the fanned-in/metricsendpoint), plus next-step links into the existing configuration guide and reference.How: every technical claim was verified against the monorepo source at the
op-supernode/v0.2.2-rc.8tag the sibling pages track (op-supernode/README.md,justfile,flags/flags.go,cmd/main.go,supernode/supernode.go,resources/rpc_router.go,resources/metrics_fan_in.go,activity/heartbeat/heartbeat.go,activity/supernode/supernode.go, plusop-service/rpc/cli.goandop-service/metrics/cli.gofor server defaults). Details that only exist ondevelop(for example the--dependency-setflag and the RPC readiness gate) were deliberately left out because they are not in rc.8. The page is added to thedocs.jsonnav under Node Operators → Guides → Configuration (before the existing configuration guide, so setup precedes tuning), and the existingsupernode.mdxgains two cross-links to it; no redirects are needed for a net-new URL. Reviewer consideration: a Docker image target for op-supernode exists (.github/images.json,ops/docker/op-stack-go/Dockerfile), but published-tag availability could not be confirmed from this environment, so the page documents build-from-source only — a Docker install path can be added once the registry tag scheme for op-supernode release candidates is confirmed.Tracks ethereum-optimism/solutions#945
Part of ethereum-optimism/solutions#790.
🤖 Generated with Claude Code
Generated by Claude Code