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 #1206

Closed
wants to merge 57 commits into from
Closed

Cleanup #1206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
b65d34d
metal updates
paulgnz Jul 22, 2024
cec1a86
Merge pull request #1 from MetalPay/paul
paulgnz Jul 22, 2024
bc03920
update readme
paulgnz Jul 22, 2024
31abb8c
Merge pull request #2 from MetalPay/paul
paulgnz Jul 22, 2024
e3bedbb
rpc endpoints
paulgnz Jul 23, 2024
65340d6
endpoints
paulgnz Jul 23, 2024
3685c74
Merge pull request #3 from MetalPay/paul
paulgnz Jul 23, 2024
965300b
updated endpoints
paulgnz Jul 23, 2024
9cffe95
Merge pull request #4 from MetalPay/paul
paulgnz Jul 23, 2024
6ccdc6b
remove banner
paulgnz Jul 23, 2024
5977a5c
Merge pull request #5 from MetalPay/paul
paulgnz Jul 23, 2024
a7b7365
update icons, chain constants
paulgnz Jul 31, 2024
730a77d
Merge pull request #6 from MetalPay/paul
paulgnz Jul 31, 2024
7a33b3a
prep bridged token addresses for Metal L2
paulgnz Jul 31, 2024
6ed5e36
Merge pull request #7 from MetalPay/paul
paulgnz Jul 31, 2024
d905727
updated rpc providers page
paulgnz Sep 5, 2024
f144a37
Merge pull request #8 from MetalPay/paul
paulgnz Sep 5, 2024
07aa682
fixed url
paulgnz Sep 5, 2024
af9a240
Merge pull request #9 from MetalPay/paul
paulgnz Sep 5, 2024
2da3b35
feat: fix chainids to pull in correct contract addresses
squdgy Sep 26, 2024
af9cb03
Merge pull request #10 from MetalPay/fix_contract_addresses
squdgy Sep 26, 2024
35149cd
Added Biconomy Integration below Networks
B-Venkatesh7210 Oct 2, 2024
0cc04d7
Merge pull request #11 from B-Venkatesh7210/biconomy-integration
squdgy Oct 2, 2024
1497741
Changes for Metal L2 references
squdgy Oct 16, 2024
097fcf4
Merge pull request #12 from MetalPay/metal_l2_refs
squdgy Oct 16, 2024
fbc776a
feat: general cleanup of terms, links, etc.
squdgy Nov 29, 2024
ed98174
feat: general cleanup of links, words, etc.
squdgy Nov 29, 2024
7211201
fix space issues; fix all broken links
squdgy Nov 29, 2024
2d2d7c4
linting cleanup
squdgy Nov 29, 2024
da82cce
Merge pull request #13 from MetalPay/cleanup
squdgy Nov 29, 2024
3cb1bad
Update token list
squdgy Dec 24, 2024
ad6a03c
update holocene update page
squdgy Dec 24, 2024
a1fe5cf
Merge pull request #14 from MetalPay/tokenlist
squdgy Dec 24, 2024
afb079c
metal updates
paulgnz Jul 22, 2024
097cb9d
update readme
paulgnz Jul 22, 2024
d7fb03f
rpc endpoints
paulgnz Jul 23, 2024
84a6416
endpoints
paulgnz Jul 23, 2024
7f020b9
updated endpoints
paulgnz Jul 23, 2024
06d691c
remove banner
paulgnz Jul 23, 2024
00c6f71
update icons, chain constants
paulgnz Jul 31, 2024
ee4040c
prep bridged token addresses for Metal L2
paulgnz Jul 31, 2024
c3d5086
updated rpc providers page
paulgnz Sep 5, 2024
3102fe9
fixed url
paulgnz Sep 5, 2024
b8d126b
feat: fix chainids to pull in correct contract addresses
squdgy Sep 26, 2024
9d75310
Added Biconomy Integration below Networks
B-Venkatesh7210 Oct 2, 2024
0befaae
Changes for Metal L2 references
squdgy Oct 16, 2024
95b7ffe
feat: general cleanup of terms, links, etc.
squdgy Nov 29, 2024
1144f93
feat: general cleanup of links, words, etc.
squdgy Nov 29, 2024
449ba9e
fix space issues; fix all broken links
squdgy Nov 29, 2024
1e43f35
linting cleanup
squdgy Nov 29, 2024
ffb45bf
Update token list
squdgy Dec 24, 2024
9ee392e
update holocene update page
squdgy Dec 24, 2024
5ebc681
fix links
squdgy Dec 26, 2024
1a29a8c
Merge branch 'main' into dec
squdgy Dec 27, 2024
279a301
merge fixes
squdgy Dec 27, 2024
8b81323
Merge pull request #15 from MetalPay/dec
squdgy Dec 27, 2024
bc5faae
Fix some links to refer to Metal L2 and not OP Mainnet. Link offsite …
squdgy Dec 27, 2024
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
10 changes: 2 additions & 8 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,8 +1,2 @@
* @ethereum-optimism/docs-reviewers

# Giving Marine privileges to review RPC providers, account abstraction, oracles, alt-da, and block explorers
/pages/builders/tools/connect/rpc-providers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/builders/tools/build/block-explorers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/builders/tools/build/oracles.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/builders/chain-operators/features/alt-da-mode.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/builders/tools/build/account-abstraction.mdx @ethereum-optimism/docs-reviewers @0xmariniere
# Code reviewers
* @squdgy @paulgnz
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?
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_faq_item.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.optimism.io/contribute/style-guide#faqs). <br> For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.optimism.io/security/faq#security-model-faq).
Before submitting this suggestion, be sure to read our expectations for [FAQ content](https://docs.metall2.com/contribute/style-guide#faqs). <br> For an example FAQ guide with question+answer pairs, see [Security Model FAQ](https://docs.metall2.com/security/faq#security-model-faq).
- type: markdown
id: project_info
attributes:
Expand All @@ -26,7 +26,7 @@ body:
id: faq_where_should_it_live
attributes:
label: What page will this FAQ item live?
description: list the page where the FAQ (question + answer) would be most relevant on docs.optimism.io
description: list the page where the FAQ (question + answer) would be most relevant on docs.metall2.com
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/suggest_glossary_term.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.optimism.io/resources/glossary).
Before suggesting a new glossary term or glossary term update, make sure you've read [glossary page](https://docs.metall2.com/resources/glossary).
- type: markdown
attributes:
value: |
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.optimism.io/contribute/style-guide#troubleshooting-guides). <br> For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.optimism.io/builders/chain-operators/management/troubleshooting).
Before submitting this suggestion, be sure to read our expectations for [troubleshooting content](https://docs.metall2.com/contribute/style-guide#troubleshooting-guides). <br> For an example troubleshooting guide with problem+solution pairs, see [Troubleshooting: L2 Rollup](https://docs.metall2.com/builders/chain-operators/management/troubleshooting).
- type: markdown
id: project_info
attributes:
Expand All @@ -26,7 +26,7 @@ body:
id: troubleshooting_where_should_it_live
attributes:
label: What page will this troubleshooting item live?
description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.optimism.io
description: list the page where the troubleshooting (problem + solution) would be most relevant on docs.metall2.com
validations:
required: true
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/suggest_tutorial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: markdown
attributes:
value: |
We'll consider [our defined content types](https://docs.optimism.io/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first.
We'll consider [our defined content types](https://docs.metall2.com/contribute/style-guide#content-types/) when reviewing the tutorial, so please take a look there first.
- type: markdown
id: tutorial_info
attributes:
Expand Down Expand Up @@ -46,7 +46,7 @@ body:
id: tutorial_hosted
attributes:
label: Hosted on Optimism.io or hosted elsewhere?
description: Let us know if you want your tutorial to be hosted on the docs.optimism.io website or if it is published elsewhere and you want us to link out to the tutorial
description: Let us know if you want your tutorial to be hosted on the docs.metall2.com website or if it is published elsewhere and you want us to link out to the tutorial
options:
- "Hosted on optimism.io"
- "Hosted elsewhere"
Expand Down
48 changes: 48 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Check Links

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build-and-run-lychee:
runs-on: ubuntu-latest

steps:
- name: Checkout MetalPay/metal-l2-docs
uses: actions/checkout@v2
with:
repository: 'MetalPay/metal-l2-docs'
path: 'docs'

- name: Checkout lycheeverse/lychee
uses: actions/checkout@v2
with:
repository: 'lycheeverse/lychee'
path: 'lychee'

- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal

- name: Cache Rust dependencies
uses: Swatinem/rust-cache@v2
with:
save-if: ${{ github.ref == 'refs/heads/main' }}

- name: Build Lychee
run: |
cd lychee
cargo build --release

- name: Add Lychee to PATH
run: echo "$GITHUB_WORKSPACE/lychee/target/release" >> $GITHUB_PATH

- name: Run Lychee
run: |
cd docs
lychee --config ./lychee.toml --quiet "./pages"
40 changes: 20 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Contributing to Optimism Docs
# Contributing to Metal L2 Docs

Thanks for taking the time to contribute! ❤️

Optimism's documentation is open-source, hosted on GitHub in the `ethereum-optimism/docs` repository which renders on the corresponding official website hosted at [docs.optimism.io](https://docs.optimism.io). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time. We will be running a dedicated project in the future to add language support to the technical docs, so please reach out via our [developer support channel](https://github.com/ethereum-optimism/developers/) if you are interested in helping with that project.
Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal-l2-docs` repository which renders on the corresponding official website hosted at [docs.metall2.com](https://docs.metall2.com). This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. Please note that contributions, pull requests, and issues should be written in English at this time.

The Optimism 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:
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 Optimism documentation implies 2 steps:
Contributing to the Metal L2 documentation implies 2 steps:

1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Optimism's documentation.
1. Learn how to use [Nextra](#learn-how-to-use-nextra), the tool used to write and generate Metal L2's documentation.

2. [Submit a pull request](#send-pull-request) for review.

## Learn How to Use Nextra

Optimism's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features.
Metal L2's documentation is built with the React and Markdown-based [Nextra](https://nextra.site/docs) framework. We are using the docs theme (as opposed to the blog theme), which has specialized features.

To start contributing to Optimism's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine.
To start contributing to Metal L2's documentation using Nextra, you need to understand the [files and branches architecture](#understand-file-architecture-and-branch-names) and use the proper [syntax to format content](#use-proper-formatting-and-syntax). Additionally, if you want to work locally from a repository fork, you should [set up the Nextra project](#set-up-the-project-and-test-locally) on your machine.

### Understand File Architecture and Branch Names

Optimism's documentation includes two major sections with each section living in a different folder.
Metal L2's documentation includes two major sections with each section living in a different folder.

| Section name | Target content | Folder |
| ------------------| ----------------------------------------------------------------- | ----------------------------- |
Expand All @@ -32,15 +32,15 @@ Optimism's documentation includes two major sections with each section living in

**Warning**
The `public` folder also stores the `robots.txt` and `sitemap.xml` files used for SEO. Please do not modify these pages.
The Optimism Documentation team will modify these pages, when necessary, after your PR is merged.
The Metal L2 Documentation team will modify these pages, when necessary, after your PR is merged.

### Use Proper Formatting and Syntax

Nextra is MDX-based, meaning the content you write is [Markdown](https://daringfireball.net/projects/markdown/syntax) that accepts [React](https://reactjs.org/) components.

The Optimism Documentation team has created a complete style guide for you to make the best out of the various options available:
The Metal L2 Documentation team has created a complete style guide for you to make the best out of the various options available:

[Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx)
[Metal L2 Documentation Style Guide](/pages/connect/contribute/style-guide.mdx)

### Set Up the Project and Test Locally

Expand All @@ -66,32 +66,32 @@ To prevent building issues upstream, you should build the content locally before
- Try another `pnpm dev` and repeat until no issues are reported ("client" and "server compiled successfully").


Your pull request should usually target the `main` branch, though the Optimism Documentation team might sometimes ask you to target another branch.
Your pull request should usually target the `main` branch, though the Metal L2 Documentation team might sometimes ask you to target another branch.

To submit your contribution for review:

1. Create a new [pull request on GitHub](https://github.com/ethereum-optimism/docs/issues/new/choose).
1. Create a new [pull request on GitHub](https://github.com/MetalPay/metal-l2-docs/issues/new/choose).
2. Select a PR type from the list or choose **Open a blank issue** at the bottom of the page.
3. Complete the form as requested. For blank PR issues, please provide a clear title and accurate description/context.
4. Click the "Create pull request" button to create the pull request effectively.

>If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Optimism documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)".
>If your pull request is not ready for review yet, choose the "[Create draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"in the dropdown. The Metal L2 documentation team will review your pull request only when you mark it as "[Ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)".

5. Add GitHub labels for the pull request. Add `documentation` to all pull requests in this repo **AND** additional labels based on the type of update or request.
- `tutorial`, `faq`, or `troubleshooting` for specific content types,
- `oracle`, `rpc-provider`, `faucet`, or `attestation` for ecosystem offerings,
- `user feedback` for general feedback about one or more pages, or
- `bug` if something isn't working as expected.
>If label for type of update is not set, the Optimism Documentation team will set or update this for you<br/>
>If label for type of update is not set, the Metal L2 Documentation team will set or update this for you<br/>

**Warning**
Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.optimism.io. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release.
Approved pull requests are usually merged immediately into the `main` branch, automatically triggering a deployment on docs.metall2.com. Please add the `flag:merge-pending-release` label if the pull request content should only be released publicly in sync with a product release.

That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Optimism Documentation team will merge it, and the content will be live on [docs.optimism.io](http://docs.optimism.io) a few minutes later. 🚀
That's it! 🥳 Once the pull request is [reviewed and approved](#review-and-management-of-pull-requests), the Metal L2 Documentation team will merge it, and the content will be live on [docs.metall2.com](http://docs.metall2.com) a few minutes later. 🚀

## Review and Management of Pull Requests

The pull request review process and timeline are based on the availability of the Optimism Documentation team to handle community contributions. The workflow is as follows:
The pull request review process and timeline are based on the availability of the Metal L2 Documentation team to handle community contributions. The workflow is as follows:

1. The pull request is assigned to a member of the Documentation team.
2. At least 1 member of the Documentation team will review the pull request for:
Expand All @@ -101,7 +101,7 @@ The pull request review process and timeline are based on the availability of th
- alignment with the documentation scope.

3. Reviewers will either approve, ask for changes, or reject the pull request.
4. Accepted pull requests will be merged and automatically deployed on [docs.optimism.io](https://docs.optimism.io) a few minutes later.
4. Accepted pull requests will be merged and automatically deployed on [docs.metall2.com](https://docs.metall2.com) a few minutes later.

## Other Ways to Support the Project
All types of contributions are encouraged and valued.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Optimism Docs
# Metal L2 Docs

This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.
This repo houses the Metal L2 Docs forked from Optimism located at [docs.metall2.com](https://docs.metall2.com/). All documentation-related updates and new content will be tracked and maintained in this repo.

## Local Development

Expand All @@ -12,11 +12,11 @@ Then, run `pnpm dev` to start the development server and visit localhost:3000.

## Contributions

Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the [Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the [Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.

## Project Board

You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo.
You can track documentation [issues](https://github.com/MetalPay/metal-l2-docs/issues) or submit documentation [requests](https://github.com/MetalPay/metal-l2-docs/issues/new/choose) directly from this repo.

## License

Expand Down
6 changes: 2 additions & 4 deletions components/TokenListTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ import tokenlist from '@eth-optimism/tokenlist'

const explorers = {
'1': 'https://etherscan.io',
'5': 'https://goerli.etherscan.io',
'10': 'https://optimistic.etherscan.io',
'420': 'https://goerli-optimism.etherscan.io',
'11155111': 'https://sepolia.etherscan.io/',
'11155420': 'https://sepolia-optimism.etherscan.io/',
'1750' : 'https://explorer.metall2.com/',
'1740' : 'https://testnet.explorer.metall2.com/',
}

export function TokenListTable({
Expand Down
12 changes: 7 additions & 5 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ remap = [
]

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

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

Expand All @@ -29,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',
'https://optimism.easscan.org'
Expand Down
2 changes: 1 addition & 1 deletion next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
Loading