From 2162e5a7ed4035a20a42ecddb29e6b958902bdb6 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 7 Mar 2025 07:25:36 -0800 Subject: [PATCH 1/5] app-devs-metakeywords --- keywords.config.yaml | 32 +++++++++++++++++-- .../chain-operators/architecture.mdx | 16 +++++++++- .../chain-operators/configuration.mdx | 11 +++++++ .../chain-operators/configuration/batcher.mdx | 13 +++++++- .../configuration/overview.mdx | 11 +++++++ .../configuration/proposer.mdx | 13 ++++++++ .../chain-operators/configuration/rollup.mdx | 16 +++++++++- pages/operators/chain-operators/deploy.mdx | 13 ++++++++ .../chain-operators/deploy/genesis.mdx | 14 ++++++++ .../chain-operators/deploy/overview.mdx | 14 ++++++++ .../deploy/smart-contracts.mdx | 14 ++++++++ pages/operators/chain-operators/features.mdx | 11 +++++++ .../chain-operators/features/alt-da-mode.mdx | 13 +++++++- .../features/bridged-usdc-standard.mdx | 14 ++++++++ .../chain-operators/features/preinstalls.mdx | 17 ++++++++-- .../chain-operators/features/span-batches.mdx | 14 ++++++++ .../operators/chain-operators/management.mdx | 15 +++++++++ .../management/best-practices.mdx | 14 +++++++- .../chain-operators/management/blobs.mdx | 18 +++++++++-- .../management/key-management.mdx | 11 +++++++ .../chain-operators/management/operations.mdx | 10 ++++++ .../chain-operators/management/snap-sync.mdx | 11 +++++++ .../management/troubleshooting.mdx | 11 +++++++ .../operators/chain-operators/self-hosted.mdx | 15 ++++++++- pages/operators/chain-operators/tools.mdx | 15 +++++++++ .../tools/chain-monitoring.mdx | 10 ++++++ .../chain-operators/tools/explorer.mdx | 11 +++++++ .../chain-operators/tools/fee-calculator.mdx | 9 ++++++ .../chain-operators/tools/op-challenger.mdx | 13 +++++++- .../chain-operators/tools/op-conductor.mdx | 14 ++++++++ .../chain-operators/tools/op-deployer.mdx | 12 +++++-- .../chain-operators/tools/op-txproxy.mdx | 12 +++++++ .../chain-operators/tools/op-validator.mdx | 4 +++ .../chain-operators/tools/proxyd.mdx | 14 ++++++++ pages/operators/chain-operators/tutorials.mdx | 17 +++++++++- .../adding-derivation-attributes.mdx | 12 +++++++ .../tutorials/adding-precompiles.mdx | 13 ++++++++ .../tutorials/chain-dev-net.mdx | 17 ++++++++-- .../tutorials/create-l2-rollup.mdx | 15 ++++++++- .../tutorials/integrating-da-layer.mdx | 12 +++++++ .../tutorials/modifying-predeploys.mdx | 12 +++++++ 41 files changed, 534 insertions(+), 19 deletions(-) diff --git a/keywords.config.yaml b/keywords.config.yaml index 47bc6beb6..572f585e4 100644 --- a/keywords.config.yaml +++ b/keywords.config.yaml @@ -64,6 +64,7 @@ metadata_rules: - block-times - data-availability - data-availability-layer + - blob-configuration # Sequencing Layer - sequencer @@ -71,6 +72,7 @@ metadata_rules: - sequencer-decentralization - sequencer-in-a-box - op-batcher + - batcher-configuration - outages - downtime - optimism-portal @@ -82,7 +84,10 @@ metadata_rules: - sequencing-layer # Derivation Layer - - rollup-node + - rollup-node + - rollup-configuration + - consensus-client + - op-node - fault-proofs - fp-contracts - dispute-game @@ -90,6 +95,7 @@ metadata_rules: - fault-tolerance - fault-proof-system - contests + - span-batches - virtual-machine - op-challenger - safe-head @@ -113,6 +119,9 @@ metadata_rules: - custom-gas-token - gas - gas-configuration + - fee-optimization + - node-configuration + - gas-optimization - rpc - mempool - block-production @@ -120,10 +129,12 @@ metadata_rules: - transactions - conditional-transactions - l2-contracts + - transaction-management - account-abstraction - paymasters - l1-data-fee - execution-gas-fee + - execution-client - eip-1559 - sequencer-fee-vault - dev-console # Tool: execution layer interaction @@ -132,10 +143,12 @@ metadata_rules: # Settlement Layer - l1-contracts - superchain-contracts + - op-contracts - standard-bridge - custom-bridge - superchain-erc20 - deposits + - proxy - withdrawals - teleportr - bridging @@ -156,6 +169,7 @@ metadata_rules: - message-validation - transaction-flow - l1-l2-communication + - l2-output-submission - message-proving - message-finalization - l2-to-l1 @@ -172,6 +186,7 @@ metadata_rules: - state-commitment - contract-addresses - settlement-layer + - proposer-configuration # Governance Layer - security-council @@ -185,6 +200,7 @@ metadata_rules: - delegates - voting - audits + - privileged-roles - security-policy - security-model - security-reviews @@ -202,7 +218,6 @@ metadata_rules: - superchain - superchain-registry - security-council - - blockspace-charters - contract-upgrades - governance-layer @@ -220,10 +235,16 @@ metadata_rules: - testing - alphanets - betanets + - l2-rollup - chain-deployment - layer2-scaling + - system-components - smart-contracts + - deployment-artifacts - local-development-environment + - genesis-configuration + - genesis-creation + - chain-configuration - kurtosis - docker @@ -242,6 +263,7 @@ metadata_rules: - dispute-mon - monitorism - vertical-scaling + - chain-operation # Protocol Releases - granite @@ -253,16 +275,21 @@ metadata_rules: - fjord - network-upgrade - hard-fork + - hardfork-activation + - protocol-upgrades # Infrastructure & Operations - kubernetes-infrastructure - devops-tooling - artifacts-packaging - peer-management-service + - node-management - proxyd - zdd-service - snapman - op-beat + - consensus-awareness + - load-balancing - monitoring # General monitoring tools and services - analytics # Analytics platforms and data analysis - security-monitoring-response @@ -278,6 +305,7 @@ metadata_rules: - system-configuration - development-networks - network-upgrades + - key-management # Development Languages & SDKs - solidity diff --git a/pages/operators/chain-operators/architecture.mdx b/pages/operators/chain-operators/architecture.mdx index 409288879..367302a74 100644 --- a/pages/operators/chain-operators/architecture.mdx +++ b/pages/operators/chain-operators/architecture.mdx @@ -1,7 +1,21 @@ --- title: Chain architecture -lang: en-US description: Learn about the OP chain architecture. +lang: en-US +content_type: guide +topic: chain-architecture +personas: + - chain-operator + - protocol-developer +categories: + - mainnet + - testnet + - chain-configuration + - chain-deployment + - chain-operation + - node-management + - architecture +is_imported_content: 'false' --- import Image from 'next/image' diff --git a/pages/operators/chain-operators/configuration.mdx b/pages/operators/chain-operators/configuration.mdx index 46e9508c5..d23e6703f 100644 --- a/pages/operators/chain-operators/configuration.mdx +++ b/pages/operators/chain-operators/configuration.mdx @@ -2,6 +2,17 @@ title: Configuration lang: en-US description: Overview of configuration options for batchers, chain operators, proposers, and rollup deployments. +content_type: landing-page +topic: chain-configuration +personas: + - chain-operator + - protocol-developer +categories: + - batcher + - proposer + - rollup-configuration + - chain-configuration +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/configuration/batcher.mdx b/pages/operators/chain-operators/configuration/batcher.mdx index f4b0659a4..d341b5a3b 100644 --- a/pages/operators/chain-operators/configuration/batcher.mdx +++ b/pages/operators/chain-operators/configuration/batcher.mdx @@ -1,7 +1,18 @@ --- title: Batcher configuration -lang: en-US description: Learn the OP Stack batcher configurations. +lang: en-US +content_type: guide +topic: batcher-configuration +personas: + - chain-operator +categories: + - mainnet + - protocol + - data-availability + - sequencer + - gas-optimization +is_imported_content: 'false' --- import { Callout, Tabs } from 'nextra/components' diff --git a/pages/operators/chain-operators/configuration/overview.mdx b/pages/operators/chain-operators/configuration/overview.mdx index cfa5b6e19..edfff7fbb 100644 --- a/pages/operators/chain-operators/configuration/overview.mdx +++ b/pages/operators/chain-operators/configuration/overview.mdx @@ -2,6 +2,17 @@ title: Chain Operator Configurations lang: en-US description: Learn the how to configure an OP Stack chain. +content_type: landing-page +topic: chain-operator-configurations +personas: + - chain-operator + - node-operator +categories: + - mainnet + - testnet + - chain-configuration + - system-components +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/configuration/proposer.mdx b/pages/operators/chain-operators/configuration/proposer.mdx index 56fdeb8da..c72b22a17 100644 --- a/pages/operators/chain-operators/configuration/proposer.mdx +++ b/pages/operators/chain-operators/configuration/proposer.mdx @@ -2,6 +2,19 @@ title: Proposer Configuration lang: en-US description: Learn the OP Stack proposer configurations. +content_type: guide +topic: proposer-configuration +personas: + - chain-operator +categories: + - mainnet + - testnet + - op-proposer + - state-commitment + - l2-output-submission + - dispute-game + - transaction-management +is_imported_content: 'false' --- import { Tabs } from 'nextra/components' diff --git a/pages/operators/chain-operators/configuration/rollup.mdx b/pages/operators/chain-operators/configuration/rollup.mdx index 9070c13e0..aa083cc75 100644 --- a/pages/operators/chain-operators/configuration/rollup.mdx +++ b/pages/operators/chain-operators/configuration/rollup.mdx @@ -1,7 +1,21 @@ --- title: Rollup deployment configuration -lang: en-US description: Learn about the OP Stack rollup deployment configurations. +lang: en-US +content_type: guide +topic: rollup-deployment-configuration +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-deployment + - network-parameters + - system-configuration + - hardfork-activation + - genesis-configuration + - protocol-upgrades +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/deploy.mdx b/pages/operators/chain-operators/deploy.mdx index 369ad9942..4827931ca 100644 --- a/pages/operators/chain-operators/deploy.mdx +++ b/pages/operators/chain-operators/deploy.mdx @@ -2,6 +2,19 @@ title: Deploy lang: en-US description: Information on OP Stack genesis creation, deployment overview, and smart contract deployment. +content_type: landing-page +topic: chain-deployment +personas: + - chain-operator + - protocol-developer +categories: + - chain-deployment + - chain-configuration + - chain-operation + - node-management + - genesis-creation + - deployment-artifacts +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/deploy/genesis.mdx b/pages/operators/chain-operators/deploy/genesis.mdx index dc8d8b0ed..e29b79b2c 100644 --- a/pages/operators/chain-operators/deploy/genesis.mdx +++ b/pages/operators/chain-operators/deploy/genesis.mdx @@ -2,6 +2,20 @@ title: OP Stack genesis creation lang: en-US description: Learn how to create a genesis file for the OP Stack. +content_type: guide +topic: genesis-creation +personas: + - chain-operator +categories: + - mainnet + - testnet + - op-deployer + - op-geth + - op-node + - op-contracts + - rollup-configuration + - genesis-configuration +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/deploy/overview.mdx b/pages/operators/chain-operators/deploy/overview.mdx index db4e5d3d8..c9f8885b2 100644 --- a/pages/operators/chain-operators/deploy/overview.mdx +++ b/pages/operators/chain-operators/deploy/overview.mdx @@ -2,6 +2,20 @@ title: OP Stack deployment overview lang: en-US description: Learn about the different components of deploying a standard OP Stack chain. +content_type: guide +topic: chain-deployment-overview +personas: + - chain-operator +categories: + - chain-deployment + - system-components + - op-deployer + - consensus-client + - execution-client + - batcher + - proposer + - op-challenger +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/deploy/smart-contracts.mdx b/pages/operators/chain-operators/deploy/smart-contracts.mdx index 778e3b7be..128523e9f 100644 --- a/pages/operators/chain-operators/deploy/smart-contracts.mdx +++ b/pages/operators/chain-operators/deploy/smart-contracts.mdx @@ -2,6 +2,20 @@ title: OP Stack Smart Contract Deployment lang: en-US description: Learn how to deploy the OP Stack L1 smart contracts. +content_type: guide +topic: smart-contract-deployment +personas: + - chain-operator +categories: + - chain-deployment + - op-deployer + - op-geth + - op-node + - op-contracts + - rollup-configuration + - genesis-configuration + - deployment-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/features.mdx b/pages/operators/chain-operators/features.mdx index 1f1f7a1a5..6a7bc96e8 100644 --- a/pages/operators/chain-operators/features.mdx +++ b/pages/operators/chain-operators/features.mdx @@ -4,6 +4,17 @@ lang: en-US description: >- Learn about features in the Optimism ecosystem. This guide provides detailed information and resources about features. +content_type: landing-page +topic: features +personas: + - chain-operator + - protocol-developer +categories: + - alt-da + - bridged-usdc-standard + - preinstalls + - span-batches +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/features/alt-da-mode.mdx b/pages/operators/chain-operators/features/alt-da-mode.mdx index d31b0719a..8e7410742 100644 --- a/pages/operators/chain-operators/features/alt-da-mode.mdx +++ b/pages/operators/chain-operators/features/alt-da-mode.mdx @@ -1,7 +1,18 @@ --- title: How to run an Alt-DA mode chain -lang: en-US description: Learn how to configure and run an Alt-DA mode chain within the OP Stack. +lang: en-US +content_type: guide +topic: run-alt-da-mode-chain +personas: + - chain-operator +categories: + - mainnet + - testnet + - alt-da + - data-availability + - chain-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/features/bridged-usdc-standard.mdx b/pages/operators/chain-operators/features/bridged-usdc-standard.mdx index 9158881b2..3c03aa62e 100644 --- a/pages/operators/chain-operators/features/bridged-usdc-standard.mdx +++ b/pages/operators/chain-operators/features/bridged-usdc-standard.mdx @@ -2,6 +2,20 @@ title: Bridged USDC Standard on OP Stack lang: en-US description: This guide explains how chain operators can deploy USDC on their OP Stack chain. +content_type: guide +topic: bridged-usdc-standard +personas: + - chain-operator +categories: + - mainnet + - testnet + - op-contracts + - l1-contracts + - l2-contracts + - standard-bridge + - custom-bridge + - superchain-erc20 +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/features/preinstalls.mdx b/pages/operators/chain-operators/features/preinstalls.mdx index 8757fce65..0267095bb 100644 --- a/pages/operators/chain-operators/features/preinstalls.mdx +++ b/pages/operators/chain-operators/features/preinstalls.mdx @@ -1,7 +1,20 @@ --- -title: Preinstalls -lang: en-US +title: OP Stack preinstalls description: Learn how to use preinstalls on your chain. +lang: en-US +content_type: guide +topic: op-stack-preinstalls +personas: + - chain-operator +categories: + - mainnet + - testnet + - preinstalls + - predeploys + - smart-contracts + - genesis-configuration + - chain-deployment +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/features/span-batches.mdx b/pages/operators/chain-operators/features/span-batches.mdx index 76317ff2f..cde20f893 100644 --- a/pages/operators/chain-operators/features/span-batches.mdx +++ b/pages/operators/chain-operators/features/span-batches.mdx @@ -2,6 +2,20 @@ title: Span Batches lang: en-US description: Learn how to use and enable span batches on your chain. +content_type: guide +topic: span-batches +personas: + - chain-operator +categories: + - mainnet + - testnet + - op-node + - op-contracts + - rollup-configuration + - genesis-configuration + - deployment-configuration + - batch-submission +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/management.mdx b/pages/operators/chain-operators/management.mdx index a8137ad97..6394ecaf5 100644 --- a/pages/operators/chain-operators/management.mdx +++ b/pages/operators/chain-operators/management.mdx @@ -4,6 +4,21 @@ lang: en-US description: >- Learn about management in the Optimism ecosystem. This guide provides detailed information and resources about management. +content_type: landing-page +topic: management +personas: + - chain-operator + - protocol-developer +categories: + - chain-operation + - chain-configuration + - best-practices + - blobs + - key-management + - rollup-operations + - snap-sync + - troubleshooting +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/best-practices.mdx b/pages/operators/chain-operators/management/best-practices.mdx index ae9a80a28..68216c5fc 100644 --- a/pages/operators/chain-operators/management/best-practices.mdx +++ b/pages/operators/chain-operators/management/best-practices.mdx @@ -1,7 +1,19 @@ --- title: Chain operator best practices -lang: en-US description: Learn some best practices for managing the OP Stack's off-chain components. +lang: en-US +content_type: guide +topic: chain-operator-best-practices +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-operation + - node-management + - security + - deployment-artifacts +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/blobs.mdx b/pages/operators/chain-operators/management/blobs.mdx index 686199822..9fe416312 100644 --- a/pages/operators/chain-operators/management/blobs.mdx +++ b/pages/operators/chain-operators/management/blobs.mdx @@ -1,7 +1,21 @@ --- -title: Using blobs -lang: en-US +title: Using Blobs description: Learn how to switch to using blobs for your chain. +lang: en-US +content_type: guide +topic: using-blobs +personas: + - chain-operator +categories: + - mainnet + - testnet + - data-availability + - ecotone + - blob-configuration + - fee-optimization + - batcher-configuration + - chain-operation +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/key-management.mdx b/pages/operators/chain-operators/management/key-management.mdx index 5518195d5..4c4f51b86 100644 --- a/pages/operators/chain-operators/management/key-management.mdx +++ b/pages/operators/chain-operators/management/key-management.mdx @@ -2,6 +2,17 @@ title: Key management lang: en-US description: A guide for chain operators on managing private keys on their chain, covering hot and cold wallets, and the use of an HSM. +content_type: guide +topic: key-management +personas: + - chain-operator +categories: + - mainnet + - testnet + - key-management + - privileged-roles + - security +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/operations.mdx b/pages/operators/chain-operators/management/operations.mdx index 3306c315d..093945d07 100644 --- a/pages/operators/chain-operators/management/operations.mdx +++ b/pages/operators/chain-operators/management/operations.mdx @@ -2,6 +2,16 @@ title: Rollup operations lang: en-US description: Learn basics of rollup operations, such as how to start and stop your rollup, get your rollup config, and how to add nodes. +content_type: guide +topic: rollup-operations +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-operation + - rollup-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/snap-sync.mdx b/pages/operators/chain-operators/management/snap-sync.mdx index ee7175e0d..3f753a8ae 100644 --- a/pages/operators/chain-operators/management/snap-sync.mdx +++ b/pages/operators/chain-operators/management/snap-sync.mdx @@ -2,6 +2,17 @@ title: Using snap sync for chain operators lang: en-US description: Learn how to use and enable snap sync on your OP chain. +content_type: guide +topic: snap-sync +personas: + - chain-operator +categories: + - mainnet + - testnet + - node-management + - chain-operation + - rollup-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/management/troubleshooting.mdx b/pages/operators/chain-operators/management/troubleshooting.mdx index afaefb063..f635b230f 100644 --- a/pages/operators/chain-operators/management/troubleshooting.mdx +++ b/pages/operators/chain-operators/management/troubleshooting.mdx @@ -2,6 +2,17 @@ title: Troubleshooting chain operations lang: en-US description: Learn solutions to common problems when troubleshooting chain operations. +content_type: guide +topic: chain-troubleshooting +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-deployment + - batcher-configuration + - chain-management +is_imported_content: 'false' --- # Troubleshooting: chain operations diff --git a/pages/operators/chain-operators/self-hosted.mdx b/pages/operators/chain-operators/self-hosted.mdx index 2a25e51f4..747eef727 100644 --- a/pages/operators/chain-operators/self-hosted.mdx +++ b/pages/operators/chain-operators/self-hosted.mdx @@ -1,7 +1,20 @@ --- title: How to start a self-hosted chain -lang: en-US description: Learn how to start a self-hosted OP Chain with standard configuration. +lang: en-US +content_type: guide +topic: how-to-start-a-self-hosted-chain +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-deployment + - chain-configuration + - chain-operation + - node-management + - system-components +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools.mdx b/pages/operators/chain-operators/tools.mdx index 8940801a2..d46a54afa 100644 --- a/pages/operators/chain-operators/tools.mdx +++ b/pages/operators/chain-operators/tools.mdx @@ -4,6 +4,21 @@ lang: en-US description: >- Learn about tools in the Optimism ecosystem. This guide provides detailed information and resources about tools. +content_type: landing-page +topic: tools +personas: + - chain-operator + - protocol-developer +categories: + - chain-monitoring + - fee-calculator + - op-validator + - op-challenger + - op-conductor + - op-txproxy + - proxyd + - op-deployer +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/chain-monitoring.mdx b/pages/operators/chain-operators/tools/chain-monitoring.mdx index 22e154211..17178ff4d 100644 --- a/pages/operators/chain-operators/tools/chain-monitoring.mdx +++ b/pages/operators/chain-operators/tools/chain-monitoring.mdx @@ -2,6 +2,16 @@ title: Chain monitoring options lang: en-US description: Learn about onchain and offchain monitoring options for your OP Stack chain. +content_type: guide +topic: chain-monitoring +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-operation + - node-management +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/explorer.mdx b/pages/operators/chain-operators/tools/explorer.mdx index 3046fe498..bc422fcd2 100644 --- a/pages/operators/chain-operators/tools/explorer.mdx +++ b/pages/operators/chain-operators/tools/explorer.mdx @@ -2,6 +2,17 @@ title: Block explorer lang: en-US description: Learn how to deploy a Blockscout block explorer for your OP Stack chain. +content_type: guide +topic: block-explorer +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-operation + - node-management + - testnet-tooling +is_imported_content: 'false' --- import { Callout } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/fee-calculator.mdx b/pages/operators/chain-operators/tools/fee-calculator.mdx index 053cf3601..9bfdc6448 100644 --- a/pages/operators/chain-operators/tools/fee-calculator.mdx +++ b/pages/operators/chain-operators/tools/fee-calculator.mdx @@ -2,6 +2,15 @@ title: Fjord fee parameter calculator lang: en-US description: Use the Fjord Fee Parameter Calculator to estimate and calculate fees for transactions. +content_type: guide +topic: fee-calculator +personas: + - chain-operator +categories: + - mainnet + - testnet + - fee-optimization +is_imported_content: 'false' --- import { ChainParametersForm } from '@/components/calculator/ChainParametersForm' diff --git a/pages/operators/chain-operators/tools/op-challenger.mdx b/pages/operators/chain-operators/tools/op-challenger.mdx index ff1927eae..ab59047f2 100644 --- a/pages/operators/chain-operators/tools/op-challenger.mdx +++ b/pages/operators/chain-operators/tools/op-challenger.mdx @@ -1,7 +1,18 @@ --- title: How to configure challenger for your chain -lang: en-US description: Learn how to configure challenger for your OP Stack chain. +lang: en-US +content_type: tutorial +topic: configure-challenger-for-your-chain +personas: + - chain-operator +categories: + - mainnet + - testnet + - fault-proofs + - op-challenger + - chain-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/op-conductor.mdx b/pages/operators/chain-operators/tools/op-conductor.mdx index 2d3714ff5..817b435ad 100644 --- a/pages/operators/chain-operators/tools/op-conductor.mdx +++ b/pages/operators/chain-operators/tools/op-conductor.mdx @@ -2,6 +2,20 @@ title: Conductor lang: en-US description: Learn what the op-conductor is and how to use it to create a highly available and reliable sequencer. +content_type: tutorial +topic: op-conductor +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-operation + - node-management + - chain-configuration + - reorgs + - op-node + - sequencer +is_imported_content: 'false' --- import { Callout, Tabs, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/op-deployer.mdx b/pages/operators/chain-operators/tools/op-deployer.mdx index 636065ef3..4c21baee7 100644 --- a/pages/operators/chain-operators/tools/op-deployer.mdx +++ b/pages/operators/chain-operators/tools/op-deployer.mdx @@ -1,8 +1,16 @@ --- title: Deployer -lang: en-US -tags: ["op-deployer","eng-platforms"] description: Learn how op-deployer can simplify deploying a standard OP Stack Chain. +lang: en-US +content_type: tutorial +topic: deployer +personas: + - chain-operator +categories: + - testnet + - chain-deployment + - op-deployer +is_imported_content: 'false' --- import {Callout, Steps} from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/op-txproxy.mdx b/pages/operators/chain-operators/tools/op-txproxy.mdx index 26ca735d6..db35cbbef 100644 --- a/pages/operators/chain-operators/tools/op-txproxy.mdx +++ b/pages/operators/chain-operators/tools/op-txproxy.mdx @@ -2,6 +2,18 @@ title: op-txproxy lang: en-US description: A passthrough proxy service that can apply additional constraints on transactions prior to reaching the sequencer. +content_type: tutorial +topic: op-txproxy +personas: + - chain-operator +categories: + - mainnet + - testnet + - op-node + - proxyd + - docker + - chain-configuration +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tools/op-validator.mdx b/pages/operators/chain-operators/tools/op-validator.mdx index 8b22960f2..3a9c930f8 100644 --- a/pages/operators/chain-operators/tools/op-validator.mdx +++ b/pages/operators/chain-operators/tools/op-validator.mdx @@ -10,6 +10,10 @@ personas: categories: - tools - op-validator + - chain-configuration + - chain-deployment + - chain-operation + - node-management is_imported_content: 'false' --- diff --git a/pages/operators/chain-operators/tools/proxyd.mdx b/pages/operators/chain-operators/tools/proxyd.mdx index 51a43b7c4..32c9f10e8 100644 --- a/pages/operators/chain-operators/tools/proxyd.mdx +++ b/pages/operators/chain-operators/tools/proxyd.mdx @@ -2,6 +2,20 @@ title: proxyd lang: en-US description: Learn about the proxyd service and how to configure it for use in the OP Stack. +content_type: guide +topic: proxyd +personas: + - chain-operator + - protocol-developer +categories: + - mainnet + - testnet + - rpc + - node-management + - load-balancing + - chain-operation + - consensus-awareness +is_imported_content: 'false' --- import { Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials.mdx b/pages/operators/chain-operators/tutorials.mdx index a8d5e5cd9..c8aafa822 100644 --- a/pages/operators/chain-operators/tutorials.mdx +++ b/pages/operators/chain-operators/tutorials.mdx @@ -1,9 +1,24 @@ --- title: Tutorials -lang: en-US description: >- Learn about tutorials in the Optimism ecosystem. This guide provides detailed information and resources about tutorials. +lang: en-US +content_type: landing-page +topic: chain-operator-tutorials +personas: + - chain-operator + - protocol-developer +categories: + - derivation + - testnet + - local-devnet + - alt-da + - precompiles + - predeploys + - l2-rollup + - viem +is_imported_content: 'false' --- import { Card, Cards } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx b/pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx index fea90610d..cb0405b81 100644 --- a/pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx +++ b/pages/operators/chain-operators/tutorials/adding-derivation-attributes.mdx @@ -2,6 +2,18 @@ title: Adding attributes to the derivation function lang: en-US description: Learn how to modify the derivation function for an OP Stack chain to track the amount of ETH being burned on L1. +content_type: tutorial +topic: adding-derivation-attributes +personas: + - chain-operator + - protocol-developer +categories: + - chain-operation + - chain-configuration + - chain-deployment + - node-management + - derivation +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/adding-precompiles.mdx b/pages/operators/chain-operators/tutorials/adding-precompiles.mdx index 98b352c73..2f4e8557c 100644 --- a/pages/operators/chain-operators/tutorials/adding-precompiles.mdx +++ b/pages/operators/chain-operators/tutorials/adding-precompiles.mdx @@ -2,6 +2,19 @@ title: Adding a precompile lang: en-US description: Learn how to run an EVM with a new precompile for OP Stack chain operations to speed up calculations that are not currently supported. +content_type: tutorial +topic: adding-precompiles +personas: + - chain-operator + - protocol-developer +categories: + - op-geth + - op-node + - chain-configuration + - chain-operation + - precompiles + - node-management +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/chain-dev-net.mdx b/pages/operators/chain-operators/tutorials/chain-dev-net.mdx index 236a87e87..9d75d3513 100644 --- a/pages/operators/chain-operators/tutorials/chain-dev-net.mdx +++ b/pages/operators/chain-operators/tutorials/chain-dev-net.mdx @@ -1,7 +1,20 @@ --- -title: Running a Local Network Environment -lang: en-US +title: Running a Local Development Environment description: This tutorial walks you through spinning up an OP Stack devnet chain. +lang: en-US +content_type: tutorial +topic: running-a-local-development-environment +personas: + - chain-operator +categories: + - testnet + - local-devnet + - chain-deployment + - docker + - chain-configuration + - chain-operation + - node-management +is_imported_content: 'false' --- import {Callout, Steps} from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/create-l2-rollup.mdx b/pages/operators/chain-operators/tutorials/create-l2-rollup.mdx index cf4dffbb8..9aea479f1 100644 --- a/pages/operators/chain-operators/tutorials/create-l2-rollup.mdx +++ b/pages/operators/chain-operators/tutorials/create-l2-rollup.mdx @@ -1,7 +1,20 @@ --- title: Creating your own L2 rollup testnet -lang: en-US description: This tutorial walks you through spinning up an OP Stack testnet chain. +lang: en-US +content_type: tutorial +topic: creating-your-own-l2-rollup-testnet +personas: + - chain-operator +categories: + - mainnet + - testnet + - chain-deployment + - chain-configuration + - chain-operation + - node-management + - op-deployer +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/integrating-da-layer.mdx b/pages/operators/chain-operators/tutorials/integrating-da-layer.mdx index 63ce7762a..275eb2f06 100644 --- a/pages/operators/chain-operators/tutorials/integrating-da-layer.mdx +++ b/pages/operators/chain-operators/tutorials/integrating-da-layer.mdx @@ -2,6 +2,18 @@ title: Integrating a new DA layer with Alt-DA lang: en-US description: Learn how to add support for a new DA Layer within the OP Stack. +content_type: tutorial +topic: integrating-da-layer +personas: + - chain-operator + - protocol-developer +categories: + - alt-da + - chain-configuration + - chain-deployment + - chain-operation + - node-management +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' diff --git a/pages/operators/chain-operators/tutorials/modifying-predeploys.mdx b/pages/operators/chain-operators/tutorials/modifying-predeploys.mdx index 4391673c0..b82454ccb 100644 --- a/pages/operators/chain-operators/tutorials/modifying-predeploys.mdx +++ b/pages/operators/chain-operators/tutorials/modifying-predeploys.mdx @@ -2,6 +2,18 @@ title: Modifying predeployed contracts lang: en-US description: Learn how to modify predeployed contracts for an OP Stack chain by upgrading the proxy. +content_type: tutorial +topic: modifying-predeploys +personas: + - chain-operator + - protocol-developer +categories: + - chain-operation + - chain-configuration + - chain-deployment + - node-management + - proxy +is_imported_content: 'false' --- import { Callout, Steps } from 'nextra/components' From 75aa0084749d40a8847a2b163817f9aa87b7b62a Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 7 Mar 2025 14:13:06 -0800 Subject: [PATCH 2/5] Update keywords.config.yaml --- keywords.config.yaml | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/keywords.config.yaml b/keywords.config.yaml index 6f4e65797..572f585e4 100644 --- a/keywords.config.yaml +++ b/keywords.config.yaml @@ -49,7 +49,7 @@ metadata_rules: required: true multiple: true min: 1 - max: 5 + max: 8 validation_rules: - no_duplicates: true description: "Categories must not repeat" @@ -65,7 +65,7 @@ metadata_rules: - data-availability - data-availability-layer - blob-configuration - + # Sequencing Layer - sequencer - sequencer-pbs @@ -98,6 +98,11 @@ metadata_rules: - span-batches - virtual-machine - op-challenger + - safe-head + - derivation + - derivation-pipeline + - derivation-layer + - batch-submission - cannon - zk - op-workbench # Tool: derivation testing & simulation @@ -122,6 +127,7 @@ metadata_rules: - block-production - block-execution - transactions + - conditional-transactions - l2-contracts - transaction-management - account-abstraction @@ -132,17 +138,29 @@ metadata_rules: - eip-1559 - sequencer-fee-vault - dev-console # Tool: execution layer interaction - + - execution-layer + # Settlement Layer - l1-contracts - superchain-contracts - op-contracts - standard-bridge + - custom-bridge - superchain-erc20 - deposits - proxy - withdrawals - teleportr + - bridging + - token-standard + - token-bridge + - eth-bridging + - superchain-weth + - superchain-token-bridge + - token-deployment + - event-reading + - block-safety + - dependency-set - interoperability - cross-chain-messaging - cross-domain-messenger @@ -157,6 +175,7 @@ metadata_rules: - l2-to-l1 - token-transfers - interoperable-assets + - reorgs - op-deployer # Tool: contract deployment - op-supervisor - transaction-finality @@ -192,23 +211,22 @@ metadata_rules: - safety-mechanisms - pause - emergency-response - - # Governance Layer - - security-council - op-token - blockspace-charters - retro-funding - revshare-enshrinement + - superchain - superchain-registry - security-council - contract-upgrades - governance-layer # Cross-layer Development Tools + - architecture + - op-stack - supersim # Tests across multiple layers - - devnets # Full-stack local environment + - devnet # Full-stack local environment - performance-tooling # Stack-wide performance testing - - superchain-registry # Chain management across layers - l1-deployment-upgrade-tooling # Cross-layer deployment - l2-deployment-upgrade-tooling # Cross-layer deployment - testnet-tooling # testnet-specific tools like faucets, block explorers, etc @@ -310,11 +328,6 @@ metadata_rules: - testnet - mainnet - # Superchain Categories - - superchain-registry - - security-council - - blockspace-charters - # Test Networks - sepolia # Ethereum L1 testnet - op-sepolia # OP Stack L2 testnet From b472553ac3863b3a6035398ed0fe3c53b371e334 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 7 Mar 2025 15:31:07 -0800 Subject: [PATCH 3/5] Update keywords.config.yaml --- keywords.config.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/keywords.config.yaml b/keywords.config.yaml index 572f585e4..b65e327e5 100644 --- a/keywords.config.yaml +++ b/keywords.config.yaml @@ -1,3 +1,6 @@ +--- +# Keywords config file + # Metadata Configuration for Documentation metadata_rules: # PERSONA From 7e1de11e9aad9576d6b5af8222be8fe73f12383c Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 7 Mar 2025 15:35:40 -0800 Subject: [PATCH 4/5] Update keywords.config.yaml --- keywords.config.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/keywords.config.yaml b/keywords.config.yaml index b65e327e5..f5b6b5af2 100644 --- a/keywords.config.yaml +++ b/keywords.config.yaml @@ -220,7 +220,6 @@ metadata_rules: - revshare-enshrinement - superchain - superchain-registry - - security-council - contract-upgrades - governance-layer From 28ebd9a4fa82a68755e7c9a3f174a50c7d715f29 Mon Sep 17 00:00:00 2001 From: cpengilly <29023967+cpengilly@users.noreply.github.com> Date: Fri, 7 Mar 2025 18:59:38 -0800 Subject: [PATCH 5/5] Update keywords.config.yaml --- keywords.config.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/keywords.config.yaml b/keywords.config.yaml index f5b6b5af2..47cbf9ac5 100644 --- a/keywords.config.yaml +++ b/keywords.config.yaml @@ -336,6 +336,16 @@ metadata_rules: - base-sepolia # Base testnet - zora-sepolia # Zora testnet + # IS_IMPORTED_CONTENT + is_imported_content: + required: true + multiple: false + validation_rules: + - enum: + - 'true' + - 'false' + description: "Must be either 'true' for imported/duplicate pages or 'false' for original pages" + # TIMEFRAME timeframe: required_for: