Skip to content

Commit da82cce

Browse files
squdgysqudgy
authored
Merge pull request #13 from MetalPay/cleanup
Cleanup of terms, links etc.
2 parents 097fcf4 + 2d2d7c4 commit da82cce

39 files changed

+315
-817
lines changed

‎.github/ISSUE_TEMPLATE/general_docs_request.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: General docs request
3-
about: Template for general documentation requests from the Optimism Collective
3+
about: Template for general documentation requests for the Metal L2 docs
44
title: "[DOCS] Add PR title"
55
labels: 'community-request,documentation'
66

@@ -20,4 +20,4 @@ Provide links to any related content pages for this documentation request. This
2020

2121
## Additional Context
2222
Provide any additional context about this documentation request. What problems did you run into that caused you to make this request?
23-
Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers in the Optimism Collective?
23+
Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers working with Metal L2?

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal
66

77
The Metal L2 Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:
88

9-
- forking the `docs` repository and working locally,
9+
- forking the `metal-l2-docs` repository and working locally,
1010
- or, for smaller updates, clicking the `Edit this page` link on the right side of any documentation page to directly edit in GitHub.
1111

1212
Contributing to the Metal L2 documentation implies 2 steps:

‎lychee.toml‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ no_progress = true
1111
# URL remapping rules.
1212
remap = [
1313
"file:///(.*?)/pages/img/(.*) file:///$1/public/img/$2",
14+
"file:///(.*?)/pages/resources/(.*) file:///$1/public/resources/$2",
1415
"file:///([^#.?]+)(#.*)?$ file:///$1.mdx$2",
1516
"\\\\& &"
1617
]
1718

1819
# Base URL or website root directory to check relative URLs.
19-
base = "./pages"
20+
# base = "./pages"
2021

2122
############################# Exclusions ##########################
2223

@@ -28,12 +29,14 @@ exclude_mail = true
2829

2930
# Exclude RPC URLs from checking.
3031
exclude = [
31-
'https://mainnet.optimism.io',
32-
'https://mainnet-sequencer.optimism.io',
33-
'https://sepolia.optimism.io',
34-
'https://sepolia-sequencer.optimism.io',
32+
'https://rpc.metall2.com/',
33+
'https://testnet.rpc.metall2.com/',
34+
'https://mainnet-sequencer.metall2.com/',
35+
'https://testnet-sequencer.metall2.com/',
3536
'https://archive.org',
3637
'https://web.archive.org',
38+
'https://mainnet.optimism.io',
39+
'https://sepolia.optimism.io',
3740
'https://mainnet.base.org',
3841
'https://sepolia.base.org'
3942
]

‎notes/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Optimism Docs Docs
1+
# Metal L2 Docs
22

3-
The Optimism Docs Docs are internal docs to help you understand how the Optimism Docs are built and maintained.
3+
The Metal L2 Docs are internal docs to help you understand how the Metal L2 Docs are built and maintained.
44

5-
- [How the Optimism Docs Use Nextra](./nextra.md)
6-
- [How the Optimism Docs Use Remark](./remark.md)
5+
- [How the Metal L2 Docs Use Nextra](./nextra.md)
6+
- [How the Metal L2 Docs Use Remark](./remark.md)
77
- [GitHub Actions](./actions.md)

‎notes/nextra.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# How the Optimism Docs Use Nextra
1+
# How the Metal L2 Docs Use Nextra
22

3-
The Optimism Docs use the [Nextra](https://nextra.site/) documentation framework.
3+
The Metal L2 Docs use the [Nextra](https://nextra.site/) documentation framework.
44
Nextra is essentially a combination of [Next.js](https://nextjs.org/) + [MDX](https://mdxjs.com/) and allows you to write React components that can be used within Markdown pages.
55
Nextra documentation is decent and can explain the basics of how to do most of the things you might want to do.
66
This page documents all of the things that we do that are currently not made obvious by Nextra's docs.

‎pages/builders/app-developers/overview.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,18 @@ The Standard Token Bridge for Metal L2 even uses this same message-passing infra
5151
If you're a bit more familiar with Metal L2 and Ethereum, you can try walking through one of the tutorials put together by the Optimism community.
5252
They'll help you get a head start when building your first Optimistic project.
5353

54-
| Tutorial Name | Description | Difficulty Level |
55-
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
56-
| [Deploying Your First Contract on Metal L2](tutorials/first-contract) | Learn how to deploy your first contract to Metal L2 with Remix and MetaMask. | 🟢 Easy |
57-
| [Deploying Your Contracts for Free on the Superchain](tutorials/deploy-for-free) | Learn how to deploy your contracts for free on the Superchain using the Superchain Developer Console | 🟢 Easy |
54+
| Tutorial Name | Description | Difficulty Level |
55+
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
56+
| [Deploying Your First Contract on Metal L2](tutorials/first-contract) | Learn how to deploy your first contract to Metal L2 with Remix and MetaMask. | 🟢 Easy |
57+
| [Deploying Your Contracts for Free on the Superchain](tutorials/deploy-for-free) | Learn how to deploy your contracts for free on the Superchain using the Superchain Developer Console | 🟢 Easy |
5858
| [Bridging ETH With the Optimism SDK](tutorials/cross-dom-bridge-eth) | Learn how to use the Optimism SDK to transfer ETH between Layer 1 (Ethereum or Sepolia) and Layer 2 (Metal L2 or Metal L2 Testnet). | 🟢 Easy |
5959
| [Bridging ERC-20 Tokens With the Optimism SDK](tutorials/cross-dom-bridge-erc20) | Learn how to use the Optimism SDK to transfer ERC-20 tokens between Layer 1 (Ethereum or Sepolia) and Layer 2 (Metal L2 or Metal L2 Testnet). | 🟢 Easy |
60-
| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium |
61-
| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token) | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium |
62-
| [Tracing Deposits and Withdrawals With the Optimism SDK](tutorials/sdk-trace-txns) | Learn how to use the Optimism SDK to trace deposits and withdrawals. | 🟢 Easy |
63-
| [Viewing Deposits and Withdrawals by Address With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to view deposits and withdrawals by address. | 🟢 Easy |
64-
| [Estimating Transaction Costs With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to estimate the cost of a transaction on Metal L2. | 🟢 Easy |
65-
| [Sending Metal L2 Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to Metal L2 from Ethereum. | 🟢 Easy |
60+
| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium |
61+
| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token) | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge. | 🟡 Medium |
62+
| [Tracing Deposits and Withdrawals With the Optimism SDK](tutorials/sdk-trace-txns) | Learn how to use the Optimism SDK to trace deposits and withdrawals. | 🟢 Easy |
63+
| [Viewing Deposits and Withdrawals by Address With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to view deposits and withdrawals by address. | 🟢 Easy |
64+
| [Estimating Transaction Costs With the Optimism SDK](tutorials/sdk-view-txns) | Learn how to use the Optimism SDK to estimate the cost of a transaction on Metal L2. | 🟢 Easy |
65+
| [Sending Metal L2 Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to Metal L2 from Ethereum. | 🟢 Easy |
6666

6767
You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list!
6868

‎pages/builders/chain-operators/architecture.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ requests from your users. The Sequencer node has the important job of working wi
5656
the batcher to handle block creation. To allow the Sequencer to focus on that job,
5757
you can peer replica nodes to handle the rest of the work.
5858

59-
An example of this would be to configure [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd)
59+
An example of this would be to configure [proxyd](https://docs.optimism.io/builders/chain-operators/tools/proxyd)
6060
to route RPC methods, retry failed requests, load balance, etc. Users sending
6161
`eth_sendRawTransaction` requests can have their requests forwarded directly to the
6262
Sequencer. All other RPC requests can be forwarded to replica nodes.

‎pages/builders/chain-operators/features/alt-da-mode.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ For deploying your contracts, use the latest release.
110110

111111
## Inclusion Criteria
112112

113-
Alt DA teams who want to be featured on this page must meet the following criteria:
113+
Developer teams who want to feature products/tools on this page must meet the following criteria:
114114

115-
* Functional [DA Server](https://specs.optimism.io/experimental/alt-da.html#da-server), maintained in your own repo
116-
* Supporting detailed documentation, to be referenced [here](#setup-your-da-server)
117-
* Functioning OP Stack devnet using your DA server with linked configuration, contract addresses, and RPC address
115+
1. **ongoing partnership** with Metal L2 whether formal agreement, RPGF, RFP, collaborated on specific initiatives, etc.;
116+
2. **established user base** and Metal L2 ecosystem engagement such as governance participation, homegrown TG or Discord participation, etc.; and
117+
3. **actively maintained developer tool** that aligns with Metal L2's commitment to a magical developer experience (e.g., easy-to-use, easy-to-integrate, great DevX, highly rated by community, etc.)
118118

119119
## Next Steps
120120

‎pages/builders/chain-operators/tutorials/integrating-da-layer.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,4 @@ Follow our guide on [how to operate an Alt-DA Mode chain](/builders/chain-operat
4545

4646
## Next Steps
4747

48-
* Want to explore more? See an [example DA server](https://github.com/ethereum-optimism/optimism/blob/develop/op-plasma/daserver.go)
4948
* For more detail on implementing the DA Server, [see the specification](https://specs.optimism.io/experimental/alt-da.html#da-server).

‎pages/builders/node-operators/management/snapshots.mdx‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ Migrated OP Mainnet databases can be generated manually or pre-migrated database
3232
Using [aria2](https://aria2.github.io/) to download snapshots can significantly speed up the download process.
3333
</Callout>
3434

35-
### OP Mainnet (Full Node)
35+
<Callout type="error">
36+
Please reach out to the Metal L2 team on Telegram for assistance with Node Snapshots
37+
</Callout>
38+
39+
{/* ### Metal L2 (Full Node)
3640
3741
<Callout type="info">
3842
[Fastnode.io](https://fastnode.io/) provides more recent full node snapshots for OP Mainnet. You can find them [here](https://datapoint.fastnode.io/).
@@ -41,20 +45,17 @@ Migrated OP Mainnet databases can be generated manually or pre-migrated database
4145
4246
| Snapshot Date | Size | Download Link | sha256sum |
4347
| ------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
44-
| 2023-06-06 | 325GB | [Mirror 1](https://datadirs.optimism.io/mainnet-bedrock.tar.zst) <br /> [Mirror 2](https://op.datadirs.xyz/mainnet-bedrock.tar.zst) <br /> [Mirror 3 (torrent)](magnet:?xt=urn:btih:0eea90fa3da8cd88bfa34c70ccef64f5e643c4c1\&dn=mainnet-bedrock.tar.zst) | <span className="shasum">`ec4baf47e309a14ffbd586dc85376833de640c0f2a8d7355cb8a9e64c38bfcd1`</span> |
4548
46-
### OP Mainnet (Archive Node)
49+
### Metal L2 (Archive Node)
4750
4851
<Callout type="info">
4952
You can also download access the [Optimism Foundation datadir explorer](https://datadirs.optimism.io/) to find other snapshots.
5053
</Callout>
5154
5255
| Snapshot Date | Size | Download Link | sha256sum |
5356
| ----------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
54-
| Latest by Optimism Foundation | >4TB | [Mirror 1](https://datadirs.optimism.io/latest) <br /> [Mirror 2 (torrent)](https://datadirs.optimism.io/latest.torrent) | [sha256sum](https://datadirs.optimism.io/latest.sha256sum/) |
5557
56-
### OP Mainnet (Legacy)
58+
### Metal L2 (Legacy)
5759
5860
| Snapshot Date | Size | Download Link | sha256sum |
59-
| ------------- | ----- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
60-
| 2023-06-06 | 2.9TB | [Mirror 1](https://datadirs.optimism.io/mainnet-legacy-archival.tar.zst) | <span className="shasum">`4adedb61125b81b55f9bdccc2e85092050c65ef2253c86e2b79569732b772829`</span> |
61+
| ------------- | ----- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |*/}

0 commit comments

Comments
 (0)