Skip to content

Commit 63f4021

Browse files
authored
Merge branch 'main' into 250320-upgrade-erc20-to-superchain
2 parents 3685944 + 6b9a605 commit 63f4021

File tree

156 files changed

+3158
-1753
lines changed

Some content is hidden

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

156 files changed

+3158
-1753
lines changed

Diff for: .coderabbit.yaml

+3-4
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,10 @@ reviews:
3333
---
3434
```
3535
3. If any required fields are missing or empty, comment:
36-
'This file appears to be missing required metadata. You can fix this by running:
36+
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:
3737
```bash
38-
pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
39-
```
40-
Review the changes, then run without :dry to apply them.'
38+
pnpm validate-metadata
39+
```'
4140
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
4241
- Avoid gender-specific language and use the imperative form.
4342
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.

Diff for: dist/tsconfig.tsbuildinfo

-1
This file was deleted.

Diff for: keywords.config.yaml

+159-11
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,134 @@ 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+
- contract-upgrades
224+
- governance-layer
117225

118226
# Cross-layer Development Tools
227+
- architecture
228+
- op-stack
119229
- supersim # Tests across multiple layers
120-
- devnets # Full-stack local environment
230+
- devnet # Full-stack local environment
121231
- performance-tooling # Stack-wide performance testing
122-
- superchain-registry # Chain management across layers
123232
- l1-deployment-upgrade-tooling # Cross-layer deployment
124233
- l2-deployment-upgrade-tooling # Cross-layer deployment
125234
- 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
126252

127253
# Chain Management (Cross-layer)
128254
- protocol
@@ -139,6 +265,7 @@ metadata_rules:
139265
- dispute-mon
140266
- monitorism
141267
- vertical-scaling
268+
- chain-operation
142269

143270
# Protocol Releases
144271
- granite
@@ -150,21 +277,37 @@ metadata_rules:
150277
- fjord
151278
- network-upgrade
152279
- hard-fork
280+
- hardfork-activation
281+
- protocol-upgrades
153282

154283
# Infrastructure & Operations
155284
- kubernetes-infrastructure
156285
- devops-tooling
157286
- artifacts-packaging
158287
- peer-management-service
288+
- node-management
159289
- proxyd
160290
- zdd-service
161291
- snapman
162292
- op-beat
293+
- consensus-awareness
294+
- load-balancing
163295
- monitoring # General monitoring tools and services
164296
- analytics # Analytics platforms and data analysis
165297
- security-monitoring-response
166298
- stability-monitoring
167299
- 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
168311

169312
# Development Languages & SDKs
170313
- solidity
@@ -187,17 +330,22 @@ metadata_rules:
187330
- testnet
188331
- mainnet
189332

190-
# Superchain Categories
191-
- superchain-registry
192-
- security-council
193-
- blockspace-charters
194-
195333
# Test Networks
196334
- sepolia # Ethereum L1 testnet
197335
- op-sepolia # OP Stack L2 testnet
198336
- base-sepolia # Base testnet
199337
- zora-sepolia # Zora testnet
200338

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+
201349
# TIMEFRAME
202350
timeframe:
203351
required_for:

0 commit comments

Comments
 (0)