[2024 Q4 Audit] builders/chain-operators/features/preinstalls.mdx

[ZakAyesh]

Description of the updates required

The current preinstall page is missing some newer preinstalls.
For example, it is missing CreateX preinstall.

We should also include a procedure explaining how can chains add newer preinstalls to their chain, that they didn't already include at Genesis.

Acceptance criteria

Preinstalls in docs are matching the specs. A guide on adding in newer preinstalls is included on page.

Resources

Specs list on missing preinstalls
Specs Page on preinstalls

Feel free to reach out to me (Zak) for support on this issue. This was based on partner feedback in a support issue.

Action items

• Confirm which preinstalls we are missing on that page
• Add missing preinstalls to the list
• Write a short guide on this page on how chain operators can add any preinstalls that aren't already on their chain

Github issue label criteria

Choose the appropriate github issue labels for each page.

Priority

• p-on-hold: (Defer) Tasks that are currently not actionable due to various reasons like waiting for external inputs, dependencies, or resource constraints. These are reviewed periodically to decide if they can be moved to a more active status.
• p-low: (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. These tasks are often more about quality of life improvements rather than essential needs.
• p-medium: (Could do) Tasks that need to be done but are less critical than high-priority tasks. These often improve processes or efficiency but can be postponed if necessary without immediate severe repercussions.
• p-high: (Should do) Important tasks that contribute significantly to long-term goals but may not have an immediate deadline. Delaying these tasks could have considerable negative effects but are not as immediate as critical tasks.
• p-critical: Tasks that have immediate deadlines or significant consequences if not completed on time. These are non-negotiable and often linked to core business functions or legal requirements.

T-shirt size

• s-XS: (< 1 day) Very simple tasks that require minimal time and effort.
• s-S: (few days) Tasks that are straightforward but require a bit more time to complete.
• s-M: (1-2 weeks) Tasks that involve a moderate level of complexity and collaboration.
• s-L: (several weeks) Complex tasks that require significant time investment and coordination across multiple teams.
• s-XL: (> 1 month) Very large and complex projects that involve extensive planning, execution, and testing.

Content evaluation

- `a-delete`: don't need this page - `a-duplicate`: some content lives elsewhere - `a-minor`: needs small revisions - `a-moderate`: needs moderate revisions - `a-critical`: needs a lot of work

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: ["preinstalls"]
---

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