1
+ ---
2
+ # Keywords config file
3
+
1
4
# Metadata Configuration for Documentation
2
5
metadata_rules :
3
6
# PERSONA
@@ -49,7 +52,7 @@ metadata_rules:
49
52
required : true
50
53
multiple : true
51
54
min : 1
52
- max : 5
55
+ max : 8
53
56
validation_rules :
54
57
- no_duplicates : true
55
58
description : " Categories must not repeat"
@@ -62,19 +65,47 @@ metadata_rules:
62
65
- alt-da
63
66
- permissionless-batch-submission
64
67
- block-times
65
-
68
+ - data-availability
69
+ - data-availability-layer
70
+ - blob-configuration
71
+
66
72
# Sequencing Layer
67
73
- sequencer
68
74
- sequencer-pbs
69
75
- sequencer-decentralization
70
76
- sequencer-in-a-box
71
77
- 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
72
88
73
89
# Derivation Layer
74
- - rollup-node
90
+ - rollup-node
91
+ - rollup-configuration
92
+ - consensus-client
93
+ - op-node
75
94
- fault-proofs
76
95
- fp-contracts
96
+ - dispute-game
97
+ - dispute-resolution
98
+ - fault-tolerance
99
+ - fault-proof-system
100
+ - contests
101
+ - span-batches
102
+ - virtual-machine
77
103
- op-challenger
104
+ - safe-head
105
+ - derivation
106
+ - derivation-pipeline
107
+ - derivation-layer
108
+ - batch-submission
78
109
- cannon
79
110
- zk
80
111
- op-workbench # Tool: derivation testing & simulation
@@ -90,39 +121,134 @@ metadata_rules:
90
121
- preinstalls
91
122
- custom-gas-token
92
123
- gas
124
+ - gas-configuration
125
+ - fee-optimization
126
+ - node-configuration
127
+ - gas-optimization
128
+ - rpc
129
+ - mempool
130
+ - block-production
131
+ - block-execution
93
132
- transactions
133
+ - conditional-transactions
94
134
- l2-contracts
135
+ - transaction-management
95
136
- account-abstraction
96
137
- paymasters
138
+ - l1-data-fee
139
+ - execution-gas-fee
140
+ - execution-client
141
+ - eip-1559
142
+ - sequencer-fee-vault
97
143
- dev-console # Tool: execution layer interaction
98
-
144
+ - execution-layer
145
+
99
146
# Settlement Layer
100
147
- l1-contracts
148
+ - superchain-contracts
149
+ - op-contracts
101
150
- standard-bridge
151
+ - custom-bridge
102
152
- superchain-erc20
153
+ - deposits
154
+ - proxy
155
+ - withdrawals
103
156
- 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
104
167
- interoperability
105
168
- 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
106
180
- interoperable-assets
181
+ - reorgs
107
182
- op-deployer # Tool: contract deployment
108
183
- 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
109
193
110
194
# Governance Layer
111
195
- 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
112
217
- op-token
113
218
- blockspace-charters
114
219
- retro-funding
115
220
- revshare-enshrinement
221
+ - superchain
116
222
- superchain-registry
223
+ - contract-upgrades
224
+ - governance-layer
117
225
118
226
# Cross-layer Development Tools
227
+ - architecture
228
+ - op-stack
119
229
- supersim # Tests across multiple layers
120
- - devnets # Full-stack local environment
230
+ - devnet # Full-stack local environment
121
231
- performance-tooling # Stack-wide performance testing
122
- - superchain-registry # Chain management across layers
123
232
- l1-deployment-upgrade-tooling # Cross-layer deployment
124
233
- l2-deployment-upgrade-tooling # Cross-layer deployment
125
234
- testnet-tooling # testnet-specific tools like faucets, block explorers, etc
235
+ - deployment-tooling # deployment-specific tools like OPCM
236
+ - testing-environment
237
+ - testing
238
+ - alphanets
239
+ - betanets
240
+ - l2-rollup
241
+ - chain-deployment
242
+ - layer2-scaling
243
+ - system-components
244
+ - smart-contracts
245
+ - deployment-artifacts
246
+ - local-development-environment
247
+ - genesis-configuration
248
+ - genesis-creation
249
+ - chain-configuration
250
+ - kurtosis
251
+ - docker
126
252
127
253
# Chain Management (Cross-layer)
128
254
- protocol
@@ -139,6 +265,7 @@ metadata_rules:
139
265
- dispute-mon
140
266
- monitorism
141
267
- vertical-scaling
268
+ - chain-operation
142
269
143
270
# Protocol Releases
144
271
- granite
@@ -150,21 +277,37 @@ metadata_rules:
150
277
- fjord
151
278
- network-upgrade
152
279
- hard-fork
280
+ - hardfork-activation
281
+ - protocol-upgrades
153
282
154
283
# Infrastructure & Operations
155
284
- kubernetes-infrastructure
156
285
- devops-tooling
157
286
- artifacts-packaging
158
287
- peer-management-service
288
+ - node-management
159
289
- proxyd
160
290
- zdd-service
161
291
- snapman
162
292
- op-beat
293
+ - consensus-awareness
294
+ - load-balancing
163
295
- monitoring # General monitoring tools and services
164
296
- analytics # Analytics platforms and data analysis
165
297
- security-monitoring-response
166
298
- stability-monitoring
167
299
- security
300
+ - research
301
+ - beta-features
302
+ - experimental
303
+ - feature-testing
304
+ - decentralization
305
+ - modularity
306
+ - system-design
307
+ - system-configuration
308
+ - development-networks
309
+ - network-upgrades
310
+ - key-management
168
311
169
312
# Development Languages & SDKs
170
313
- solidity
@@ -187,17 +330,22 @@ metadata_rules:
187
330
- testnet
188
331
- mainnet
189
332
190
- # Superchain Categories
191
- - superchain-registry
192
- - security-council
193
- - blockspace-charters
194
-
195
333
# Test Networks
196
334
- sepolia # Ethereum L1 testnet
197
335
- op-sepolia # OP Stack L2 testnet
198
336
- base-sepolia # Base testnet
199
337
- zora-sepolia # Zora testnet
200
338
339
+ # IS_IMPORTED_CONTENT
340
+ is_imported_content :
341
+ required : true
342
+ multiple : false
343
+ validation_rules :
344
+ - enum :
345
+ - ' true'
346
+ - ' false'
347
+ description : " Must be either 'true' for imported/duplicate pages or 'false' for original pages"
348
+
201
349
# TIMEFRAME
202
350
timeframe :
203
351
required_for :
0 commit comments