Repository navigation
docs: roll the flag-reference generator out to op-node, op-proposer, op-challenger, op-conductor - #21873
Conversation
…op-challenger, op-conductor Extend the B1 gen-flags pipeline to every first-party Go service, each generated at its latest finalized release tag and pinned in manifest.json: - op-node/v1.19.3 (109 flags) replaces the 1,278-line hand catalog pinned to v1.10.2; op-proposer/v1.16.3 (54) replaces the unversioned 507-line catalog; op-challenger/v1.9.3 (88) closes the no-catalog gap with a new reference page; op-conductor/v0.9.4 (61) replaces the 15-flag partial hand list on the conductor reference page. - Snippets are generated from the source at each tag (op-proposer, op-challenger, op-conductor flag definitions have moved on develop since their tags, so their snippets are tag-generated; op-node and op-batcher are byte-identical between tag and develop). manifest.json now records a sha256 per snippet and -check verifies against it, with current-tree parity reported informationally — the multi-component tags make regenerate-and-diff meaningful only at each tag. - canonicalizeUsage stabilizes the --network usage string (the enumerated superchain-registry chain list changes with registry bumps, independent of component releases). - op-reth-config.mdx becomes a pointer at the imported op-reth CLI reference (facts in one place; placement stays with Option A). Inbound per-flag anchor links re-pointed. - generate-releases.ts canonicalizes specs-repo blob links in release bodies to the rendered specs site (deferred finding from the b2 sweep); applied to the committed op-batcher releases page. - Hand policy/context prose kept on every reworked page; one docs.json nav entry added (challenger reference). Baseline pruned for the two links this change removes. Co-Authored-By: Claude <noreply@anthropic.com>
- challenger-configuration.mdx: drop game-proposal-outputs from the utility-subcommand list — it exists on develop but not in the documented op-challenger/v1.9.3 release (whose --help lists eight subcommands). - op-reth-config.mdx: correct the l2.enginekind note — op-node defaults to reth (op-node/v1.19.3 and develop), so pairing needs no explicit engine-kind flag; the old 'defaults to geth' claim contradicted the generated flag table. Co-Authored-By: Claude <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Resolves the lint-link-policy.baseline.json conflict with #21866 (sweep batch 1) by regenerating: 296 (post-batch-1 develop) minus this branch's 2 fixes (op-batcher.mdx spec-blob-link via the generator transform, op-node-config.mdx pinned link removed by the rework) = 294 findings, 0 new, 0 stale. Co-Authored-By: Claude <noreply@anthropic.com>
|
Synced with |
sbvegan
left a comment
There was a problem hiding this comment.
just one comment to address and a meta note: the IA really needs a modern update. We'll probably do that after we fold in the "Rust" section.
Review follow-up from sbvegan on #21873: the non-kona cannon game types execute op-program, which has reached end of support, so only the kona variants are still maintained. Link the op-geth/op-program deprecation notice from the cannon-*/cannon-kona-* section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
Regenerated with --update-baseline against the specs mirror after merging origin/develop (#21866/#21849/#21842/#21860 baseline drift). 296 -> 293 entries, pure shrink: the two findings this branch fixed (op-node-config.mdx unbadged pin, op-batcher.mdx spec blob link) plus one entry already stale on develop (batcher.mdx anchor/UTM order, fixed in #21866 but never pruned there). Linter: 0 new / 0 stale. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
|
Baseline rebased after the recent develop merges (#21866/#21849/#21842/#21860), as predicted in the PR description: merged |
Sync after #21865 and #21867 merged. Conflicts resolved: - node-operators/reference/op-node-config.mdx: kept this branch's generated-snippet rework, which supersedes the hand-typed flag section (including the receipts_rpc.go re-point from #21867), per the PR's supersedes note. - scripts/lint-link-policy.baseline.json: regenerated with --update-baseline against the specs mirror (pure removal vs develop: 0 added, 2 removed - exactly the entries this PR resolves). docs.json auto-merged; union verified (Contribute group tail and Stack Components group preserved, challenger reference line added). Link-policy, nav, and redirect lints green. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
|
Synced with |
Resolves the lint-link-policy.baseline.json conflict by union of removals: develop tip's baseline (55 entries after the merged sweep batches) minus the releases/op-batcher.mdx spec-blob-link entry this branch's generator fix resolves (54 entries, pure shrink, 0 added). The branch's other baseline removal (batcher.mdx anchor-utm-order) was already resolved on develop by the merged sweeps. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
|
Synced with Lints on the merged tree: nav validator OK (415 pages, 1 allowlisted orphan), redirect lint OK (18 grandfathered), link-policy clean with baseline: 54 findings, all pre-existing baselined, 0 new. |
) The op-challenger hub's flags slot now links the new generated challenger-configuration reference instead of the no-reference-yet fallback wording, and the op-node hub's flag-reference description matches the reworked generated op-node-config page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Post-merge accuracy fixes after syncing with develop (#21873 rolled the flag-reference generator out to op-node/op-proposer/op-challenger/ op-conductor): - choose-your-node-stack: the op-node config reference is no longer hand-pinned to op-node/v1.10.2 (it is now generated per release), and the op-reth config page is now a router to the imported CLI reference; reword both Next-steps exits. Attribute the 1:1 pairing rule to the client configuration guides that actually state it. - launch-a-chain-with-fault-proofs-and-ha-sequencing: link the new generated challenger configuration reference from the defense-stack step. - run-a-fault-proof-challenger: the 'no rendered flag catalogue for op-challenger' exit is no longer true; replace it with a link to the generated challenger configuration reference. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L
…op-challenger, op-conductor (ethereum-optimism#21873) Co-authored-by: Claude <noreply@anthropic.com>
Requested by Matthew Cruz · Slack thread
Tracks ethereum-optimism/solutions#971
What
Rolls the flag-reference generator introduced in #21847 (op-batcher) out to the remaining first-party Go services, so every published flag catalog is generated from the urfave/cli definitions the binaries actually register, pinned to a finalized release:
op-node/v1.19.3op-proposer/v1.16.3op-challenger/v1.9.3op-conductor/v0.9.4op-batcher/v1.16.11node-operators/reference/op-node-config.mdx(1,278→143 lines, was pinned to v1.10.2),chain-operators/guides/configuration/proposer.mdx,chain-operators/tools/op-conductor/reference.mdx. New page:chain-operators/reference/challenger-configuration.mdx(op-challenger had no flag catalog at all).-checkredesigned around a manifestsha256pin. The components release independently, so develop's flag sources routinely sit past one component's tag while matching another's — byte-comparing a committed snippet against a regeneration from an arbitrary tree is only meaningful at the tag.manifest.jsonnow records{tag, sha256}per snippet;-checkfails on any snippet/manifest hash mismatch (hand-edit detection, valid at every commit) and reports current-tree parity informationally. New-only {component}flag supports per-tag regeneration. See the rewrittenscripts/gen-flags/README.md, including the honest residual-gap list.canonicalizeUsage: the--networkusage string enumerates the superchain-registry bundle's chain list, which changes with registry bumps independent of any release; the generator replaces the enumeration with a stable pointer so regeneration is byte-stable (documented deviation from raw--help).op-reth-config.mdxretired to a pointer at the imported op-reth CLI reference (/rust/op-reth/cli/overview,/rust/op-reth/cli/op-reth/node) — the 2,685-line hand copy was pinned to an old release and duplicated the imported surface. Six inbound per-flag anchor links re-pointed (snap-sync, reth-historical-proofs, archive-node, upgrade-19). No pages underrust/op-reth/**touched; the existingop-geth-configredirect still lands on a live page.generate-releases.ts: newrewriteSpecsBlobLinkstransform canonicalizes specs-repo blob links in release bodies to the rendered specs site (outside code blocks only, idempotent); applied to the committedreleases/op-batcher.mdx.consensus.advertisedwas documented as required but is optional in source; op-node's--network/--rollup.configexactly-one-of rule is now called out in prose (it is enforced byCheckRequiredXor, outside the required flag slice).Verification
An adversarial accuracy pass ran before this PR opened:
op-node/op-proposer/op-challenger/op-conductorbinaries built at the pinned tags: names, env vars, defaults match--helpexactly; visible-flag sets match (hidden flags excluded on both sides); sampled usage strings match.flags.go— including op-challenger'sl2-eth-rpc, whichCheckRequiredenforces unconditionally from outside its required slice, and op-conductor's nine.-checkis green for all five components; corrupting one committed snippet byte makes it fail on the sha256 pin.game-proposal-outputssubcommand that exists on develop but not in v1.9.3, and the op-reth pointer page claimed op-node defaults--l2.enginekindtogethwhen the source (tag and develop) defaults toreth.gofmt/go vetclean.Notes for reviewers
receipts_rpc.golink that docs: badge or re-point version-pinned links (sweep batch 2: guides, tutorials, notices, op-stack references) #21867 re-points (one hunk there). Whichever merges second needs a triviallint-link-policy.baseline.jsonrebase (also against docs: fix link-policy violations (mechanical classes) #21866).Reviewer checklist:
--helpat its pinned tag-checksemantics inscripts/gen-flags/README.mdread sensibly, including the residual-gap listMintlify automation (replaces the op-batcher-only prompt posted on #21847)
Placeholders below are written as
{component}(angle brackets do not survive the PR API); substitute the component name.0 9 * * 1(Mondays 09:00 UTC)ethereum-optimism/optimismAdditional prompt:
Part of the docs-improver program — see
projects/docs-improver/README.mdin ethereum-optimism/solutions.🤖 Drafted by the docs-improver agent — review before merge.
🤖 Generated with Claude Code
https://claude.ai/code/session_01EBBBR8m2V8LjzMvuG7Go2L