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

Cleanup of terms, links etc. #13

Merged
merged 4 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/general_docs_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: General docs request
about: Template for general documentation requests from the Optimism Collective
about: Template for general documentation requests for the Metal L2 docs
title: "[DOCS] Add PR title"
labels: 'community-request,documentation'

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

## Additional Context
Provide any additional context about this documentation request. What problems did you run into that caused you to make this request?
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?
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?
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal

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:

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

Contributing to the Metal L2 documentation implies 2 steps:
Expand Down
13 changes: 8 additions & 5 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ no_progress = true
# URL remapping rules.
remap = [
"file:///(.*?)/pages/img/(.*) file:///$1/public/img/$2",
"file:///(.*?)/pages/resources/(.*) file:///$1/public/resources/$2",
"file:///([^#.?]+)(#.*)?$ file:///$1.mdx$2",
"\\\\& &"
]

# Base URL or website root directory to check relative URLs.
base = "./pages"
# base = "./pages"

############################# Exclusions ##########################

Expand All @@ -28,12 +29,14 @@ exclude_mail = true

# Exclude RPC URLs from checking.
exclude = [
'https://mainnet.optimism.io',
'https://mainnet-sequencer.optimism.io',
'https://sepolia.optimism.io',
'https://sepolia-sequencer.optimism.io',
'https://rpc.metall2.com/',
'https://testnet.rpc.metall2.com/',
'https://mainnet-sequencer.metall2.com/',
'https://testnet-sequencer.metall2.com/',
'https://archive.org',
'https://web.archive.org',
'https://mainnet.optimism.io',
'https://sepolia.optimism.io',
'https://mainnet.base.org',
'https://sepolia.base.org'
]
Expand Down
8 changes: 4 additions & 4 deletions notes/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Optimism Docs Docs
# Metal L2 Docs

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

- [How the Optimism Docs Use Nextra](./nextra.md)
- [How the Optimism Docs Use Remark](./remark.md)
- [How the Metal L2 Docs Use Nextra](./nextra.md)
- [How the Metal L2 Docs Use Remark](./remark.md)
- [GitHub Actions](./actions.md)
4 changes: 2 additions & 2 deletions notes/nextra.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How the Optimism Docs Use Nextra
# How the Metal L2 Docs Use Nextra

The Optimism Docs use the [Nextra](https://nextra.site/) documentation framework.
The Metal L2 Docs use the [Nextra](https://nextra.site/) documentation framework.
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.
Nextra documentation is decent and can explain the basics of how to do most of the things you might want to do.
This page documents all of the things that we do that are currently not made obvious by Nextra's docs.
Expand Down
20 changes: 10 additions & 10 deletions pages/builders/app-developers/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,18 @@ The Standard Token Bridge for Metal L2 even uses this same message-passing infra
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.
They'll help you get a head start when building your first Optimistic project.

| Tutorial Name | Description | Difficulty Level |
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| [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 |
| [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 |
| Tutorial Name | Description | Difficulty Level |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [Sending Metal L2 Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to Metal L2 from Ethereum. | 🟢 Easy |
| [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 |
| [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 |
| [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 |
| [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 |
| [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 |
| [Sending Metal L2 Transactions from Ethereum](tutorials/send-tx-from-eth) | Learn how to send transactions to Metal L2 from Ethereum. | 🟢 Easy |

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!

Expand Down
2 changes: 1 addition & 1 deletion pages/builders/chain-operators/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ requests from your users. The Sequencer node has the important job of working wi
the batcher to handle block creation. To allow the Sequencer to focus on that job,
you can peer replica nodes to handle the rest of the work.

An example of this would be to configure [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd)
An example of this would be to configure [proxyd](https://docs.optimism.io/builders/chain-operators/tools/proxyd)
to route RPC methods, retry failed requests, load balance, etc. Users sending
`eth_sendRawTransaction` requests can have their requests forwarded directly to the
Sequencer. All other RPC requests can be forwarded to replica nodes.
Expand Down
8 changes: 4 additions & 4 deletions pages/builders/chain-operators/features/alt-da-mode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,11 @@ For deploying your contracts, use the latest release.

## Inclusion Criteria

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

* Functional [DA Server](https://specs.optimism.io/experimental/alt-da.html#da-server), maintained in your own repo
* Supporting detailed documentation, to be referenced [here](#setup-your-da-server)
* Functioning OP Stack devnet using your DA server with linked configuration, contract addresses, and RPC address
1. **ongoing partnership** with Metal L2 whether formal agreement, RPGF, RFP, collaborated on specific initiatives, etc.;
2. **established user base** and Metal L2 ecosystem engagement such as governance participation, homegrown TG or Discord participation, etc.; and
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.)

## Next Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,4 @@ Follow our guide on [how to operate an Alt-DA Mode chain](/builders/chain-operat

## Next Steps

* Want to explore more? See an [example DA server](https://github.com/ethereum-optimism/optimism/blob/develop/op-plasma/daserver.go)
* For more detail on implementing the DA Server, [see the specification](https://specs.optimism.io/experimental/alt-da.html#da-server).
15 changes: 8 additions & 7 deletions pages/builders/node-operators/management/snapshots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ Migrated OP Mainnet databases can be generated manually or pre-migrated database
Using [aria2](https://aria2.github.io/) to download snapshots can significantly speed up the download process.
</Callout>

### OP Mainnet (Full Node)
<Callout type="error">
Please reach out to the Metal L2 team on Telegram for assistance with Node Snapshots
</Callout>

{/* ### Metal L2 (Full Node)

<Callout type="info">
[Fastnode.io](https://fastnode.io/) provides more recent full node snapshots for OP Mainnet. You can find them [here](https://datapoint.fastnode.io/).
Expand All @@ -41,20 +45,17 @@ Migrated OP Mainnet databases can be generated manually or pre-migrated database

| Snapshot Date | Size | Download Link | sha256sum |
| ------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| 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> |

### OP Mainnet (Archive Node)
### Metal L2 (Archive Node)

<Callout type="info">
You can also download access the [Optimism Foundation datadir explorer](https://datadirs.optimism.io/) to find other snapshots.
</Callout>

| Snapshot Date | Size | Download Link | sha256sum |
| ----------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
| 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/) |

### OP Mainnet (Legacy)
### Metal L2 (Legacy)

| Snapshot Date | Size | Download Link | sha256sum |
| ------------- | ----- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
| 2023-06-06 | 2.9TB | [Mirror 1](https://datadirs.optimism.io/mainnet-legacy-archival.tar.zst) | <span className="shasum">`4adedb61125b81b55f9bdccc2e85092050c65ef2253c86e2b79569732b772829`</span> |
| ------------- | ----- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |*/}
Loading
Loading