Skip to content

Commit f8d3d21

Browse files
committed
metakeyword-stack-directory-update
update metakeywords for op stack directory
1 parent 74159d0 commit f8d3d21

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1243
-98
lines changed

keywords.config.yaml

Lines changed: 150 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
# Keywords config file
3+
14
# Metadata Configuration for Documentation
25
metadata_rules:
36
# PERSONA
@@ -49,7 +52,7 @@ metadata_rules:
4952
required: true
5053
multiple: true
5154
min: 1
52-
max: 5
55+
max: 8
5356
validation_rules:
5457
- no_duplicates: true
5558
description: "Categories must not repeat"
@@ -62,19 +65,47 @@ metadata_rules:
6265
- alt-da
6366
- permissionless-batch-submission
6467
- block-times
65-
68+
- data-availability
69+
- data-availability-layer
70+
- blob-configuration
71+
6672
# Sequencing Layer
6773
- sequencer
6874
- sequencer-pbs
6975
- sequencer-decentralization
7076
- sequencer-in-a-box
7177
- op-batcher
78+
- batcher-configuration
79+
- outages
80+
- downtime
81+
- optimism-portal
82+
- transaction-submission
83+
- transaction-inclusion
84+
- censorship-resistance
85+
- disaster-recovery
86+
- forced-transactions
87+
- sequencing-layer
7288

7389
# Derivation Layer
74-
- rollup-node
90+
- rollup-node
91+
- rollup-configuration
92+
- consensus-client
93+
- op-node
7594
- fault-proofs
7695
- fp-contracts
96+
- dispute-game
97+
- dispute-resolution
98+
- fault-tolerance
99+
- fault-proof-system
100+
- contests
101+
- span-batches
102+
- virtual-machine
77103
- op-challenger
104+
- safe-head
105+
- derivation
106+
- derivation-pipeline
107+
- derivation-layer
108+
- batch-submission
78109
- cannon
79110
- zk
80111
- op-workbench # Tool: derivation testing & simulation
@@ -90,39 +121,135 @@ metadata_rules:
90121
- preinstalls
91122
- custom-gas-token
92123
- gas
124+
- gas-configuration
125+
- fee-optimization
126+
- node-configuration
127+
- gas-optimization
128+
- rpc
129+
- mempool
130+
- block-production
131+
- block-execution
93132
- transactions
133+
- conditional-transactions
94134
- l2-contracts
135+
- transaction-management
95136
- account-abstraction
96137
- paymasters
138+
- l1-data-fee
139+
- execution-gas-fee
140+
- execution-client
141+
- eip-1559
142+
- sequencer-fee-vault
97143
- dev-console # Tool: execution layer interaction
98-
144+
- execution-layer
145+
99146
# Settlement Layer
100147
- l1-contracts
148+
- superchain-contracts
149+
- op-contracts
101150
- standard-bridge
151+
- custom-bridge
102152
- superchain-erc20
153+
- deposits
154+
- proxy
155+
- withdrawals
103156
- teleportr
157+
- bridging
158+
- token-standard
159+
- token-bridge
160+
- eth-bridging
161+
- superchain-weth
162+
- superchain-token-bridge
163+
- token-deployment
164+
- event-reading
165+
- block-safety
166+
- dependency-set
104167
- interoperability
105168
- cross-chain-messaging
169+
- cross-domain-messenger
170+
- message-relaying
171+
- message-passing
172+
- message-validation
173+
- transaction-flow
174+
- l1-l2-communication
175+
- l2-output-submission
176+
- message-proving
177+
- message-finalization
178+
- l2-to-l1
179+
- token-transfers
106180
- interoperable-assets
181+
- reorgs
107182
- op-deployer # Tool: contract deployment
108183
- op-supervisor
184+
- transaction-finality
185+
- ethereum-consensus
186+
- finality-guarantees
187+
- transaction-lifecycle
188+
- rollup-transactions
189+
- state-commitment
190+
- contract-addresses
191+
- settlement-layer
192+
- proposer-configuration
109193

110194
# Governance Layer
111195
- security-council
196+
- guardian
197+
- multisig
198+
- governance
199+
- optimism-collective
200+
- superchain-ecosystem
201+
- token-house
202+
- citizens-house
203+
- delegates
204+
- voting
205+
- audits
206+
- privileged-roles
207+
- security-policy
208+
- security-model
209+
- security-reviews
210+
- vulnerability-assessment
211+
- bug-bounty-program
212+
- responsible-disclosure
213+
- vulnerability-reporting
214+
- safety-mechanisms
215+
- pause
216+
- emergency-response
112217
- op-token
113218
- blockspace-charters
114219
- retro-funding
115220
- revshare-enshrinement
221+
- superchain
116222
- superchain-registry
223+
- security-council
224+
- contract-upgrades
225+
- governance-layer
117226

118227
# Cross-layer Development Tools
228+
- architecture
229+
- op-stack
119230
- supersim # Tests across multiple layers
120-
- devnets # Full-stack local environment
231+
- devnet # Full-stack local environment
121232
- performance-tooling # Stack-wide performance testing
122-
- superchain-registry # Chain management across layers
123233
- l1-deployment-upgrade-tooling # Cross-layer deployment
124234
- l2-deployment-upgrade-tooling # Cross-layer deployment
125235
- testnet-tooling # testnet-specific tools like faucets, block explorers, etc
236+
- deployment-tooling # deployment-specific tools like OPCM
237+
- testing-environment
238+
- testing
239+
- alphanets
240+
- betanets
241+
- l2-rollup
242+
- chain-deployment
243+
- layer2-scaling
244+
- system-components
245+
- smart-contracts
246+
- deployment-artifacts
247+
- local-development-environment
248+
- genesis-configuration
249+
- genesis-creation
250+
- chain-configuration
251+
- kurtosis
252+
- docker
126253

127254
# Chain Management (Cross-layer)
128255
- protocol
@@ -139,6 +266,7 @@ metadata_rules:
139266
- dispute-mon
140267
- monitorism
141268
- vertical-scaling
269+
- chain-operation
142270

143271
# Protocol Releases
144272
- granite
@@ -150,21 +278,37 @@ metadata_rules:
150278
- fjord
151279
- network-upgrade
152280
- hard-fork
281+
- hardfork-activation
282+
- protocol-upgrades
153283

154284
# Infrastructure & Operations
155285
- kubernetes-infrastructure
156286
- devops-tooling
157287
- artifacts-packaging
158288
- peer-management-service
289+
- node-management
159290
- proxyd
160291
- zdd-service
161292
- snapman
162293
- op-beat
294+
- consensus-awareness
295+
- load-balancing
163296
- monitoring # General monitoring tools and services
164297
- analytics # Analytics platforms and data analysis
165298
- security-monitoring-response
166299
- stability-monitoring
167300
- security
301+
- research
302+
- beta-features
303+
- experimental
304+
- feature-testing
305+
- decentralization
306+
- modularity
307+
- system-design
308+
- system-configuration
309+
- development-networks
310+
- network-upgrades
311+
- key-management
168312

169313
# Development Languages & SDKs
170314
- solidity
@@ -187,11 +331,6 @@ metadata_rules:
187331
- testnet
188332
- mainnet
189333

190-
# Superchain Categories
191-
- superchain-registry
192-
- security-council
193-
- blockspace-charters
194-
195334
# Test Networks
196335
- sepolia # Ethereum L1 testnet
197336
- op-sepolia # OP Stack L2 testnet

pages/stack/beta-features.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
---
22
title: Beta Features
3-
description: Learn how beta features in the OP Stack work, their benefits, and how to provide feedback.
3+
description: >-
4+
Learn how beta features in the OP Stack work, their benefits, and how to
5+
provide feedback.
46
lang: en-US
7+
content_type: guide
8+
topic: beta-features
9+
personas:
10+
- protocol-developer
11+
- app-developer
12+
categories:
13+
- protocol
14+
- feature-testing
15+
- experimental
16+
is_imported_content: 'false'
517
---
618

719
import { Callout } from 'nextra/components'

pages/stack/beta-features/alt-da-mode.mdx

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
---
2-
title: Alt-DA Mode explainer
2+
title: Alt-DA Mode Explainer
3+
description: >-
4+
Learn the basic process, benefits, and considerations for running an Alt-DA
5+
mode chain.
36
lang: en-US
4-
description: Learn the basic process, benefits, and considerations for running an Alt-DA mode chain.
7+
content_type: guide
8+
topic: alt-da-mode-explainer
9+
personas:
10+
- protocol-developer
11+
- chain-operator
12+
- app-developer
13+
categories:
14+
- protocol
15+
- alt-da
16+
- data-availability
17+
- sequencer
18+
is_imported_content: 'false'
519
---
620

721
import { Callout } from 'nextra/components'

pages/stack/components.mdx

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
---
22
title: OP Stack components
3+
description: >-
4+
Learn about OP Stack components including the different layers and modules
5+
available for development.
36
lang: en-US
4-
description: Learn about OP Stack components including the different layers and modules available for development.
7+
content_type: guide
8+
topic: op-stack-components
9+
personas:
10+
- protocol-developer
11+
- chain-operator
12+
- app-developer
13+
categories:
14+
- mainnet
15+
- protocol
16+
- architecture
17+
- system-design
18+
- modularity
19+
- settlement-layer
20+
is_imported_content: 'false'
521
---
622

723
import { Callout } from 'nextra/components'

pages/stack/design-principles.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
22
title: Design philosophy & design principles
3+
description: >-
4+
Learn the design philosophy and design principles for contributing to the OP
5+
Stack.
36
lang: en-US
4-
description: Learn the design philosophy and design principles for contributing to the OP Stack.
7+
content_type: guide
8+
topic: design-philosophy-design-principles
9+
personas:
10+
- protocol-developer
11+
- app-developer
12+
categories:
13+
- protocol
14+
- design-philosophy
15+
is_imported_content: 'false'
516
---
617

718
import { Callout } from 'nextra/components'

pages/stack/dev-net.mdx

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
---
2-
title: Running a Local Development Environment
3-
lang: en-US
2+
title: Running a local development environment
43
description: This tutorial walks you through spinning up an OP Stack devnet chain.
4+
lang: en-US
5+
content_type: guide
6+
topic: running-a-local-development-environment
7+
personas:
8+
- protocol-developer
9+
- chain-operator
10+
- app-developer
11+
categories:
12+
- testnet
13+
- protocol
14+
- local-development-environment
15+
- chain-deployment
16+
- kurtosis
17+
- docker
18+
is_imported_content: 'false'
519
---
620

721
import {Callout, Steps} from 'nextra/components'

0 commit comments

Comments
 (0)