Sitelet https://github.com/ethereum-optimism/optimism/commit/148b48c642736c141a574b688e0db2305efcd52a
Skip to content

Commit 148b48c

Browse files
sbveganclaude
sbvegan
and
claude
authored
docs: regroup the Protocol tab from eleven top-level groups to five (#23073)
Co-authored-by: Claude <noreply@anthropic.com>
1 parent 82600f1 commit 148b48c

2 files changed

Lines changed: 114 additions & 114 deletions

File tree

‎docs/public-docs/docs.json‎

Lines changed: 112 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -3390,7 +3390,7 @@
33903390
"tab": "Protocol",
33913391
"groups": [
33923392
{
3393-
"group": "Introduction",
3393+
"group": "Get started",
33943394
"pages": [
33953395
"op-stack/introduction/op-stack",
33963396
"op-stack/architecture",
@@ -3406,134 +3406,79 @@
34063406
"op-stack/protocol/differences",
34073407
"op-stack/protocol/components",
34083408
"op-stack/protocol/derivation-pipeline",
3409+
"op-stack/protocol/smart-contracts",
34093410
"op-stack/protocol/blockspace-charter",
34103411
"op-stack/protocol/outages",
3411-
"op-stack/research/block-time-research"
3412-
]
3413-
},
3414-
{
3415-
"group": "Network upgrades",
3416-
"pages": [
3417-
"op-stack/protocol/network-upgrades",
3418-
"op-stack/protocol/hardforks/lagoon",
3419-
"op-stack/protocol/hardforks/karst",
3420-
"op-stack/protocol/hardforks/jovian",
3421-
"op-stack/protocol/hardforks/isthmus",
3422-
"op-stack/protocol/hardforks/holocene",
3423-
"op-stack/protocol/hardforks/granite",
3424-
"op-stack/protocol/hardforks/fjord",
3425-
"op-stack/protocol/hardforks/ecotone",
3426-
"op-stack/protocol/hardforks/delta",
3427-
"op-stack/protocol/hardforks/canyon",
3428-
"op-stack/protocol/hardforks/regolith"
3429-
]
3430-
},
3431-
{
3432-
"group": "Stack Components",
3433-
"pages": [
3434-
"op-stack/components/index",
3412+
"op-stack/research/block-time-research",
34353413
{
3436-
"group": "Sequencing",
3437-
"pages": [
3438-
"op-stack/components/op-batcher",
3439-
"op-stack/components/op-conductor"
3440-
]
3441-
},
3442-
{
3443-
"group": "Derivation & Execution",
3414+
"group": "Transactions",
34443415
"pages": [
3445-
"op-stack/components/op-node",
3446-
"op-stack/components/kona-node",
3447-
"op-stack/components/op-reth"
3416+
"op-stack/transactions/fees",
3417+
"op-stack/transactions/fee-vaults",
3418+
"op-stack/transactions/forced-transaction",
3419+
"op-stack/transactions/transaction-finality",
3420+
"op-stack/transactions/transaction-flow"
34483421
]
34493422
},
34503423
{
3451-
"group": "Settlement & Proofs",
3424+
"group": "Bridging",
34523425
"pages": [
3453-
"op-stack/components/op-proposer",
3454-
"op-stack/components/op-challenger",
3455-
"op-stack/components/cannon",
3456-
"op-stack/components/kona-client",
3457-
"op-stack/components/kona-host",
3458-
"op-stack/components/op-contracts"
3426+
"op-stack/bridging/cross-domain",
3427+
"op-stack/bridging/deposit-flow",
3428+
"op-stack/bridging/withdrawal-flow"
34593429
]
34603430
},
34613431
{
3462-
"group": "Deployment & Infrastructure",
3463-
"pages": [
3464-
"op-stack/components/op-deployer",
3465-
"op-stack/components/proxyd"
3466-
]
3467-
}
3468-
]
3469-
},
3470-
{
3471-
"group": "Bridging",
3472-
"pages": [
3473-
"op-stack/bridging/cross-domain",
3474-
"op-stack/bridging/deposit-flow",
3475-
"op-stack/bridging/withdrawal-flow"
3476-
]
3477-
},
3478-
{
3479-
"group": "Transactions",
3480-
"pages": [
3481-
"op-stack/transactions/fees",
3482-
"op-stack/transactions/fee-vaults",
3483-
"op-stack/transactions/forced-transaction",
3484-
"op-stack/transactions/transaction-finality",
3485-
"op-stack/transactions/transaction-flow"
3486-
]
3487-
},
3488-
{
3489-
"group": "Fault Proofs",
3490-
"pages": [
3491-
"op-stack/fault-proofs/index",
3492-
"op-stack/fault-proofs/explainer",
3493-
"op-stack/fault-proofs/fp-security",
3494-
"op-stack/fault-proofs/fp-components",
3495-
"op-stack/fault-proofs/cannon",
3496-
"op-stack/fault-proofs/mips",
3497-
"op-stack/fault-proofs/challenger",
3498-
"op-stack/fault-proofs/reference",
3499-
{
3500-
"group": "Kona",
3432+
"group": "Fault Proofs",
35013433
"pages": [
3434+
"op-stack/fault-proofs/index",
3435+
"op-stack/fault-proofs/explainer",
3436+
"op-stack/fault-proofs/fp-security",
3437+
"op-stack/fault-proofs/fp-components",
3438+
"op-stack/fault-proofs/cannon",
3439+
"op-stack/fault-proofs/mips",
3440+
"op-stack/fault-proofs/challenger",
3441+
"op-stack/fault-proofs/reference",
35023442
{
3503-
"group": "Fault Proof Program Development",
3504-
"pages": [
3505-
"op-stack/fault-proofs/kona/fpp-dev/intro",
3506-
"op-stack/fault-proofs/kona/fpp-dev/env",
3507-
"op-stack/fault-proofs/kona/fpp-dev/targets",
3508-
"op-stack/fault-proofs/kona/fpp-dev/prologue",
3509-
"op-stack/fault-proofs/kona/fpp-dev/execution",
3510-
"op-stack/fault-proofs/kona/fpp-dev/epilogue"
3511-
]
3512-
},
3513-
{
3514-
"group": "Proof SDK",
3443+
"group": "Kona",
35153444
"pages": [
3516-
"op-stack/fault-proofs/kona/proof/intro",
3517-
"op-stack/fault-proofs/kona/proof/stf",
3518-
"op-stack/fault-proofs/kona/proof/fpvm-backend",
3519-
"op-stack/fault-proofs/kona/proof/custom-backend",
3520-
"op-stack/fault-proofs/kona/proof/exec-ext"
3445+
{
3446+
"group": "Fault Proof Program Development",
3447+
"pages": [
3448+
"op-stack/fault-proofs/kona/fpp-dev/intro",
3449+
"op-stack/fault-proofs/kona/fpp-dev/env",
3450+
"op-stack/fault-proofs/kona/fpp-dev/targets",
3451+
"op-stack/fault-proofs/kona/fpp-dev/prologue",
3452+
"op-stack/fault-proofs/kona/fpp-dev/execution",
3453+
"op-stack/fault-proofs/kona/fpp-dev/epilogue"
3454+
]
3455+
},
3456+
{
3457+
"group": "Proof SDK",
3458+
"pages": [
3459+
"op-stack/fault-proofs/kona/proof/intro",
3460+
"op-stack/fault-proofs/kona/proof/stf",
3461+
"op-stack/fault-proofs/kona/proof/fpvm-backend",
3462+
"op-stack/fault-proofs/kona/proof/custom-backend",
3463+
"op-stack/fault-proofs/kona/proof/exec-ext"
3464+
]
3465+
}
35213466
]
35223467
}
35233468
]
3469+
},
3470+
{
3471+
"group": "Interoperability",
3472+
"pages": [
3473+
"op-stack/interop/index",
3474+
"op-stack/interop/explainer",
3475+
"op-stack/interop/supernode",
3476+
"op-stack/interop/reorg",
3477+
"op-stack/interop/superchain-eth-bridge"
3478+
]
35243479
}
35253480
]
35263481
},
3527-
{
3528-
"group": "Interoperability",
3529-
"pages": [
3530-
"op-stack/interop/index",
3531-
"op-stack/interop/explainer",
3532-
"op-stack/interop/supernode",
3533-
"op-stack/interop/reorg",
3534-
"op-stack/interop/superchain-eth-bridge"
3535-
]
3536-
},
35373482
{
35383483
"group": "Security",
35393484
"pages": [
@@ -3563,9 +3508,64 @@
35633508
{
35643509
"group": "Reference",
35653510
"pages": [
3566-
"op-stack/reference/glossary",
3567-
"op-stack/protocol/smart-contracts",
3568-
"op-stack/protocol/superchain-registry"
3511+
{
3512+
"group": "Stack Components",
3513+
"pages": [
3514+
"op-stack/components/index",
3515+
{
3516+
"group": "Sequencing",
3517+
"pages": [
3518+
"op-stack/components/op-batcher",
3519+
"op-stack/components/op-conductor"
3520+
]
3521+
},
3522+
{
3523+
"group": "Derivation & Execution",
3524+
"pages": [
3525+
"op-stack/components/op-node",
3526+
"op-stack/components/kona-node",
3527+
"op-stack/components/op-reth"
3528+
]
3529+
},
3530+
{
3531+
"group": "Settlement & Proofs",
3532+
"pages": [
3533+
"op-stack/components/op-proposer",
3534+
"op-stack/components/op-challenger",
3535+
"op-stack/components/cannon",
3536+
"op-stack/components/kona-client",
3537+
"op-stack/components/kona-host",
3538+
"op-stack/components/op-contracts"
3539+
]
3540+
},
3541+
{
3542+
"group": "Deployment & Infrastructure",
3543+
"pages": [
3544+
"op-stack/components/op-deployer",
3545+
"op-stack/components/proxyd"
3546+
]
3547+
}
3548+
]
3549+
},
3550+
{
3551+
"group": "Network upgrades",
3552+
"pages": [
3553+
"op-stack/protocol/network-upgrades",
3554+
"op-stack/protocol/hardforks/lagoon",
3555+
"op-stack/protocol/hardforks/karst",
3556+
"op-stack/protocol/hardforks/jovian",
3557+
"op-stack/protocol/hardforks/isthmus",
3558+
"op-stack/protocol/hardforks/holocene",
3559+
"op-stack/protocol/hardforks/granite",
3560+
"op-stack/protocol/hardforks/fjord",
3561+
"op-stack/protocol/hardforks/ecotone",
3562+
"op-stack/protocol/hardforks/delta",
3563+
"op-stack/protocol/hardforks/canyon",
3564+
"op-stack/protocol/hardforks/regolith"
3565+
]
3566+
},
3567+
"op-stack/protocol/superchain-registry",
3568+
"op-stack/reference/glossary"
35693569
]
35703570
}
35713571
]

‎docs/public-docs/scripts/hardfork-registry.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ hardfork_min_versions_source: "[Upgrade 19 notice](/notices/archive/upgrade-19)"
8484
1. Create `op-stack/protocol/hardforks/<fork>.mdx` with `hardfork_lifecycle: development`
8585
and the spec link; import its generated snippet
8686
(`/snippets/generated/hardforks/<fork>.mdx`).
87-
2. Add the page to the `docs.json` nav (Protocol tab → Network upgrades
88-
group).
87+
2. Add the page to the `docs.json` nav (Protocol tab → Reference → Network
88+
upgrades group).
8989
3. When the superchain-registry schedules activation times, update the
9090
frontmatter to `scheduled` (later `active`) with those timestamps.
9191
4. Run `pnpm gen:hardforks` and commit the page and regenerated snippets

0 commit comments

Comments
 (0)