Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,10 @@ reviews:
---
```
3. If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:
'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:
```bash
pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
```
Review the changes, then run without :dry to apply them.'
pnpm validate-metadata
```'
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
Expand Down
1 change: 0 additions & 1 deletion dist/tsconfig.tsbuildinfo

This file was deleted.

170 changes: 159 additions & 11 deletions keywords.config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
# Keywords config file

# Metadata Configuration for Documentation
metadata_rules:
# PERSONA
Expand Down Expand Up @@ -49,7 +52,7 @@ metadata_rules:
required: true
multiple: true
min: 1
max: 5
max: 8
validation_rules:
- no_duplicates: true
description: "Categories must not repeat"
Expand All @@ -62,19 +65,47 @@ metadata_rules:
- alt-da
- permissionless-batch-submission
- block-times

- data-availability
- data-availability-layer
- blob-configuration

# Sequencing Layer
- sequencer
- sequencer-pbs
- sequencer-decentralization
- sequencer-in-a-box
- op-batcher
- batcher-configuration
- outages
- downtime
- optimism-portal
- transaction-submission
- transaction-inclusion
- censorship-resistance
- disaster-recovery
- forced-transactions
- sequencing-layer

# Derivation Layer
- rollup-node
- rollup-node
- rollup-configuration
- consensus-client
- op-node
- fault-proofs
- fp-contracts
- dispute-game
- dispute-resolution
- fault-tolerance
- fault-proof-system
- contests
- span-batches
- virtual-machine
- op-challenger
- safe-head
- derivation
- derivation-pipeline
- derivation-layer
- batch-submission
- cannon
- zk
- op-workbench # Tool: derivation testing & simulation
Expand All @@ -90,39 +121,134 @@ metadata_rules:
- preinstalls
- custom-gas-token
- gas
- gas-configuration
- fee-optimization
- node-configuration
- gas-optimization
- rpc
- mempool
- block-production
- block-execution
- 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

- 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
- message-relaying
- message-passing
- message-validation
- transaction-flow
- l1-l2-communication
- l2-output-submission
- message-proving
- message-finalization
- l2-to-l1
- token-transfers
- interoperable-assets
- reorgs
- op-deployer # Tool: contract deployment
- op-supervisor
- transaction-finality
- ethereum-consensus
- finality-guarantees
- transaction-lifecycle
- rollup-transactions
- state-commitment
- contract-addresses
- settlement-layer
- proposer-configuration

# Governance Layer
- security-council
- guardian
- multisig
- governance
- optimism-collective
- superchain-ecosystem
- token-house
- citizens-house
- delegates
- voting
- audits
- privileged-roles
- security-policy
- security-model
- security-reviews
- vulnerability-assessment
- bug-bounty-program
- responsible-disclosure
- vulnerability-reporting
- safety-mechanisms
- pause
- emergency-response
- op-token
- blockspace-charters
- retro-funding
- revshare-enshrinement
- superchain
- superchain-registry
- 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
- deployment-tooling # deployment-specific tools like OPCM
- testing-environment
- 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

# Chain Management (Cross-layer)
- protocol
Expand All @@ -139,6 +265,7 @@ metadata_rules:
- dispute-mon
- monitorism
- vertical-scaling
- chain-operation

# Protocol Releases
- granite
Expand All @@ -150,21 +277,37 @@ 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
- stability-monitoring
- security
- research
- beta-features
- experimental
- feature-testing
- decentralization
- modularity
- system-design
- system-configuration
- development-networks
- network-upgrades
- key-management

# Development Languages & SDKs
- solidity
Expand All @@ -187,17 +330,22 @@ metadata_rules:
- testnet
- mainnet

# Superchain Categories
- superchain-registry
- security-council
- blockspace-charters

# Test Networks
- sepolia # Ethereum L1 testnet
- op-sepolia # OP Stack L2 testnet
- 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:
Expand Down
Loading