Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2024 Q4 Audit] builders/tools/overview.mdx #1072

Open
Wazabie opened this issue Nov 5, 2024 · 0 comments
Open

[2024 Q4 Audit] builders/tools/overview.mdx #1072

Wazabie opened this issue Nov 5, 2024 · 0 comments
Labels
a-minor needs small revisions docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue. p-low (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. s-XS (< 1 day) Very simple tasks that require minimal time and effort.

Comments

@Wazabie
Copy link
Contributor

Wazabie commented Nov 5, 2024

Description of the updates required

Due to the SDK deprecation, the link under "OP tools" should be updated to either:

  1. Redirect to Viem, replacing the SDK link entirely, or
  2. Add a link to Viem alongside the SDK link for now, with plans to remove the SDK link later.

Choose the approach that best aligns with our documentation direction and SDK deprecation.

MDX Metadata format

We will be adding better metadata to the header of each page.
If I was actively searching for this page on google and this description was the search result, would I know it's the correct page?
Parse the component and feature tags to add.

tags: ["devops-tooling", "performance-tooling", "eng-devx"]
---
title: "Your Title Here"
tags: ["tag1", "tag2"]
description: "A short description of the content."
---
Component tags
op-node
op-geth
op-reth
op-erigon
op-nethermind
batcher
standard-bridge
sequencer
l1-contracts
l2-contracts
precompiles
predeploys
preinstalls
op-proposer
op-challenger
op-gov-token
op-supervisor
op-conductor
fp-contracts
cannon
op-program
asterisc
kona
superchain-registry
supersim
dev-console
opsm
mcp
mcp-l2
deputy-guardian
liveness-guard
dispute-mon
op-beat
op-signer
monitorism
blockspace-charters
op-workbench
kubernetes-infrastructure
devops-tooling
artifacts-packaging
sequencer-in-a-box
devnets
op-supervisor
performance-tooling
peer-management-service
proxyd
zdd-service
snapman
security-tools
superchain-ops
op-deployer
Engineering tags
eng-platforms
eng-growth
eng-devx
eng-protocol
eng-proofs
eng-evm
eng-security

soyboy edit: I updated the engineering org to devx because its closer related to application developer and less on the infrastructure side

@Wazabie Wazabie added docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue. p-low (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. s-XS (< 1 day) Very simple tasks that require minimal time and effort. a-minor needs small revisions labels Nov 5, 2024
@Wazabie Wazabie changed the title [2024 Q4 Audit] builders/tools/overview [2024 Q4 Audit] builders/tools/overview.mdx Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-minor needs small revisions docs-audit-2024-Q4 OP Labs documentation audit op-labs Generally assigned for OP Labs employees. Please ask before you take on this issue. p-low (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. s-XS (< 1 day) Very simple tasks that require minimal time and effort.
Projects
None yet
Development

No branches or pull requests

1 participant