From 14977419c78a9291e965f214233fbb6790b56634 Mon Sep 17 00:00:00 2001 From: Maura Wilder <560657+squdgy@users.noreply.github.com> Date: Wed, 16 Oct 2024 08:05:51 -0400 Subject: [PATCH] Changes for Metal L2 references --- .github/CODEOWNERS | 15 +-- .../ISSUE_TEMPLATE/suggest_attestation.yaml | 2 +- .github/ISSUE_TEMPLATE/suggest_faq_item.yaml | 4 +- .../ISSUE_TEMPLATE/suggest_glossary_term.yaml | 2 +- .../suggest_troubleshooting_item.yaml | 4 +- .github/ISSUE_TEMPLATE/suggest_tutorial.yaml | 4 +- .github/workflows/links.yml | 4 +- .github/workflows/tutorials.yml | 124 ------------------ CONTRIBUTING.md | 38 +++--- README.md | 6 +- next-sitemap.config.js | 2 +- notes/remark.md | 4 +- package.json | 6 +- .../chain-operators/deploy/genesis.mdx | 2 +- .../chain-operators/features/alt-da-mode.mdx | 2 +- pages/builders/notices/fp-changes.mdx | 2 +- pages/connect/contribute/docs-contribute.mdx | 10 +- pages/connect/contribute/style-guide.mdx | 2 +- 18 files changed, 49 insertions(+), 184 deletions(-) delete mode 100644 .github/workflows/tutorials.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c393b8b88..a2e119f21 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,13 +1,2 @@ -* @ethereum-optimism/docs-reviewers - -# Giving Node Squad review privileges to the following sections -/pages/builders/chain-operators/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad -/pages/chain/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad -/pages/stack/ @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad - -# Giving Marine privileges to review RPC providers 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 - -# Giving Binji privileges to review NFT tools -/pages/builders/tools/build/nft-tools.mdx @ethereum-optimism/docs-reviewers @binjix23 +# Code reviewers +* @squdgy @paulgnz \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/suggest_attestation.yaml b/.github/ISSUE_TEMPLATE/suggest_attestation.yaml index 502aafe7d..c150f4fe4 100644 --- a/.github/ISSUE_TEMPLATE/suggest_attestation.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_attestation.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.optimism.io/identity/applications). + Before submitting this suggestion, be sure to read the [listing of current attestation apps](https://docs.metall2.com/identity/applications). - type: markdown id: project_info attributes: diff --git a/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml b/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml index cb07e9acd..ec92f5c05 100644 --- a/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_faq_item.yaml @@ -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).
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).
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: @@ -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 diff --git a/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml b/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml index 0302b4e1a..09ef52483 100644 --- a/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml @@ -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: | diff --git a/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml b/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml index 287ed464d..f17083de7 100644 --- a/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml @@ -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).
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).
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: @@ -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 diff --git a/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml b/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml index f8259e873..5a2dc282a 100644 --- a/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml +++ b/.github/ISSUE_TEMPLATE/suggest_tutorial.yaml @@ -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: @@ -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" diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 4461adada..cc4824d03 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -11,10 +11,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout ethereum-optimism/docs + - name: Checkout MetalPay/metal-l2-docs uses: actions/checkout@v2 with: - repository: 'ethereum-optimism/docs' + repository: 'MetalPay/metal-l2-docs' path: 'docs' - name: Checkout lycheeverse/lychee diff --git a/.github/workflows/tutorials.yml b/.github/workflows/tutorials.yml deleted file mode 100644 index 74e8870c7..000000000 --- a/.github/workflows/tutorials.yml +++ /dev/null @@ -1,124 +0,0 @@ -name: Check Tutorials - -on: - workflow_dispatch: - schedule: - - cron: '0 0 * * *' # Runs at 00:00 UTC every day - -concurrency: - group: shared-tutorial-key - cancel-in-progress: false - -jobs: - cross-dom-bridge-erc20: - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/cross-dom-bridge-erc20.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} - - cross-dom-bridge-eth: - needs: cross-dom-bridge-erc20 - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/cross-dom-bridge-eth.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} - - sdk-estimate-costs: - needs: cross-dom-bridge-eth - runs-on: ubuntu-latest - - steps: - - name: Check out code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: '20.x' - - - name: Install pnpm - run: npm install -g pnpm - - - name: Install dependencies - run: pnpm install - - - name: Run tutorial - env: - TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }} - run: - node ./public/tutorials/sdk-estimate-costs.js - - - name: Notify Slack on failure - uses: ravsamhq/notify-slack-action@v2 - if: always() - with: - status: ${{ job.status }} - notify_when: "failure" - notification_title: "{workflow} has {status_message} (<{run_url}|view errors>)" - message_format: "{emoji} *{workflow}* {status_message} in <{repo_url}|{repo}>" - footer: "<{run_url}|View Run>" - mention_users_when: "failure,warnings" - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26bf56263..56b8aabcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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, - 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 | | ------------------| ----------------------------------------------------------------- | ----------------------------- | @@ -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 @@ -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
+>If label for type of update is not set, the Metal L2 Documentation team will set or update this for you
**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: @@ -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. diff --git a/README.md b/README.md index 564796b3a..ec734b4a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Metal L2 Docs -This repo houses the Metal L2 Docs forked from Optimism 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 @@ -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 diff --git a/next-sitemap.config.js b/next-sitemap.config.js index 6f7627d0c..125252816 100644 --- a/next-sitemap.config.js +++ b/next-sitemap.config.js @@ -1,6 +1,6 @@ /** @type {import('next-sitemap').IConfig} */ module.exports = { - siteUrl: process.env.SITE_URL || 'https://docs.optimism.io/', + siteUrl: process.env.SITE_URL || 'https://docs.metall2.com/', generateRobotsTxt: true, // (optional) generateIndexSitemap: true, // ...other options diff --git a/notes/remark.md b/notes/remark.md index 8dc5a1193..b13ae6236 100644 --- a/notes/remark.md +++ b/notes/remark.md @@ -1,6 +1,6 @@ -# How the Optimism Docs Use Remark +# How the Metal L2 Docs Use Remark -The Optimism Docs use [Nextra](https://nextra.site) as a documentation framework which uses [Remark](https://github.com/remarkjs/remark) as a markdown processor under the hood. +The Metal L2 Docs use [Nextra](https://nextra.site) as a documentation framework which uses [Remark](https://github.com/remarkjs/remark) as a markdown processor under the hood. This repository also uses [ESLint](https://eslint.org) in combination with [`eslint-plugin-mdx`](https://www.npmjs.com/package/eslint-plugin-mdx) as this plugin also uses Remark under the hood. Remark is a flexible Markdown processor with a [vibrant plugin ecosystem](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins). diff --git a/package.json b/package.json index 884691467..4daf25e33 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "op-docs", - "version": "0.0.1", - "description": "Optimism Docs", + "name": "metal-l2-docs", + "version": "0.0.2", + "description": "Metal L2 Docs", "scripts": { "lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint", "fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix", diff --git a/pages/builders/chain-operators/deploy/genesis.mdx b/pages/builders/chain-operators/deploy/genesis.mdx index 87e1ca785..5df675410 100644 --- a/pages/builders/chain-operators/deploy/genesis.mdx +++ b/pages/builders/chain-operators/deploy/genesis.mdx @@ -87,5 +87,5 @@ with `--l1-rpc`. * Learn how to [initialize](/builders/node-operators/configuration/base-config#initialization-via-genesis-file) `op-geth` with your `genesis.json` file. -* Learn how to [initialize](https://docs.optimism.io/builders/node-operators/configuration/base-config#configuring-op-node) `op-node` with your `rollup.json` file. +* Learn how to [initialize](https://docs.metall2.com/builders/node-operators/configuration/base-config#configuring-op-node) `op-node` with your `rollup.json` file. * Learn more about the off chain [architecture](/builders/chain-operators/architecture). diff --git a/pages/builders/chain-operators/features/alt-da-mode.mdx b/pages/builders/chain-operators/features/alt-da-mode.mdx index e1e933699..14143aa1b 100644 --- a/pages/builders/chain-operators/features/alt-da-mode.mdx +++ b/pages/builders/chain-operators/features/alt-da-mode.mdx @@ -90,7 +90,7 @@ For deploying your contracts, use the latest release. * Chain operators are not posting everything to Ethereum, just commitments, so chain operators will need to determine fee scalars values to charge users. The fee scalar values are network throughput dependent, so values will need to be adjusted by chain operators as needed. * Cost structure for Alt-DA Mode: The transaction data is split up into 128kb chunks and then submitted to your DA Layer. Then, 32 byte commitments are submitted (goes to batch inbox address) to L1 for each 128kb chunk. Then, figure out how much that costs relative to the amount of transactions your chain is putting through. - * Set scalar values inside the deploy config. The example below shows some possible fee scalar values, calculated assuming negligible DA Layer costs, but will need to be adjusted up or down based on network throughput - as a reminder of how to set your scalar values, see [this section](https://docs.optimism.io/builders/chain-operators/management/blobs#update-your-scalar-values-for-blobs) of the docs. + * Set scalar values inside the deploy config. The example below shows some possible fee scalar values, calculated assuming negligible DA Layer costs, but will need to be adjusted up or down based on network throughput - as a reminder of how to set your scalar values, see [this section](https://docs.metall2.com/builders/chain-operators/management/blobs#update-your-scalar-values-for-blobs) of the docs. ``` // Set in Deploy Config diff --git a/pages/builders/notices/fp-changes.mdx b/pages/builders/notices/fp-changes.mdx index 4f7a34d81..b889db0e7 100644 --- a/pages/builders/notices/fp-changes.mdx +++ b/pages/builders/notices/fp-changes.mdx @@ -17,7 +17,7 @@ If you experience difficulty at any stage of this process, please reach out to [ **ALL** withdrawals that are not finalized before the Fault Proofs upgrade executes will need to be reproven after the upgrade is complete. - * Reproving simply requires that you execute the [withdrawal proving flow](https://docs.optimism.io/stack/protocol/rollup/withdrawal-flow) again. + * Reproving simply requires that you execute the [withdrawal proving flow](https://docs.metall2.com/stack/protocol/rollup/withdrawal-flow) again. * Withdrawals prior to the Fault Proofs upgrade must wait a 7-day challenge period before finalization. As a result, any withdrawal initiated less than 7 days before the upgrade cannot be finalized before the upgrade is executed. You may want to consider waiting until after the upgrade is complete to begin a withdrawal during this 7-day window. diff --git a/pages/connect/contribute/docs-contribute.mdx b/pages/connect/contribute/docs-contribute.mdx index bfe48b94d..21b49de75 100644 --- a/pages/connect/contribute/docs-contribute.mdx +++ b/pages/connect/contribute/docs-contribute.mdx @@ -8,10 +8,10 @@ import { Callout } from 'nextra/components' # Contribute to Optimism Docs -Optimism Docs (docs.optimism.io) is an open-source project, and we welcome your contributions. Here's how you can help grow and support the Optimism Collective. +Optimism Docs (docs.metall2.com) is an open-source project, and we welcome your contributions. Here's how you can help grow and support the Optimism Collective. - We recently migrated our technical docs from community.optimism.io --> docs.optimism.io. + We recently migrated our technical docs from community.optimism.io --> docs.metall2.com. So, if you contributed to either repo in 2023, don't forget to claim your [POAP token](#claim-your-gitpoap)! @@ -42,7 +42,7 @@ Optimism Docs (docs.optimism.io) is an open-source project, and we welcome your * [Contribute to the Optimism Collective](https://github.com/ethereum-optimism/ecosystem-contributions): select from several different categories where you can make an impact such as [foundation missions](https://github.com/ethereum-optimism/ecosystem-contributions/issues?q=is%3Aissue+is%3Aopen+label%3A%22Foundation+Mission+%28RFP%29%22) or general [contributor opportunities](https://github.com/ethereum-optimism/ecosystem-contributions/issues?q=is%3Aissue+is%3Aopen+label%3A%22Contribution+Opportunity%22). -## How to work on docs.optimism.io +## How to work on docs.metall2.com Whether you're adding to the site, creating content, or working on open issues, you'll need a [GitHub](https://github.com) account. All updates are made via the GitHub PR process. This means you create a local copy of the website, make your changes and request to merge your changes. @@ -70,8 +70,8 @@ We want to transition to a more community-informed and community-generated appro ### A note on plagiarism -Only use your original work or content that you have permission to use when contributing any content or artifact to docs.optimism.io. -Many projects use open-source licensing that allows for the free sharing of information. However, if you cannot find this information, do not attempt to add it to docs.optimism.io. +Only use your original work or content that you have permission to use when contributing any content or artifact to docs.metall2.com. +Many projects use open-source licensing that allows for the free sharing of information. However, if you cannot find this information, do not attempt to add it to docs.metall2.com. Any pull requests deemed as plagiarism will get rejected. ## Claim your GitPOAP diff --git a/pages/connect/contribute/style-guide.mdx b/pages/connect/contribute/style-guide.mdx index f86efd8c1..fab02134b 100644 --- a/pages/connect/contribute/style-guide.mdx +++ b/pages/connect/contribute/style-guide.mdx @@ -27,7 +27,7 @@ This Style Guide aims to assist Optimists in writing technical content with a co ### Folder Structure -The folder structure for the [docs.optimism.io](https://github.com/ethereum-optimism/docs) repository is organized into several high-level categories under the main `pages` folder such as `builders`, `chain`, `connect`, and `stack`. +The folder structure for the [docs.metall2.com](https://github.com/ethereum-optimism/docs) repository is organized into several high-level categories under the main `pages` folder such as `builders`, `chain`, `connect`, and `stack`. The left sidebar (side navigation) is managed in the `_meta.json` file, which should be edited only for adding or deleting pages. Frequent edits may lead to merge conflicts due to ongoing content updates. Accept changes from others when committing a PR.