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

Closed
wants to merge 26 commits into from
Closed

Cleanup #1149

wants to merge 26 commits into from

Conversation

squdgy
Copy link

@squdgy squdgy commented Nov 29, 2024

Description

More cleanup after original form from Optimism docs

@squdgy squdgy requested review from 0xmariniere and a team as code owners November 29, 2024 21:32
Copy link

netlify bot commented Nov 29, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit ed98174
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/674a32f20080ff000803488a
😎 Deploy Preview https://deploy-preview-1149--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@squdgy squdgy closed this Nov 29, 2024
Copy link
Contributor

coderabbitai bot commented Nov 29, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes extensive modifications primarily focused on rebranding the documentation from "Optimism" to "Metal L2." This involves changes across multiple files, including updates to reviewer assignments in the .github/CODEOWNERS file, modifications to issue templates, and a comprehensive update of documentation files to reflect the new branding. URLs have been updated to point to the new documentation site, and various sections have been revised to ensure consistency with the Metal L2 terminology.

Changes

File Change Summary
.github/CODEOWNERS Updated reviewer assignments, removing previous entries and consolidating under @squdgy and @paulgnz.
.github/ISSUE_TEMPLATE/general_docs_request.md Updated the about field to specify "Metal L2 docs" instead of "Optimism Collective." Revised context in the "Additional Context" section.
.github/ISSUE_TEMPLATE/suggest_attestation.yaml Changed the URL for current attestation apps from optimism.io to metall2.com.
.github/ISSUE_TEMPLATE/suggest_faq_item.yaml Updated URLs from optimism.io to metall2.com.
.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml Changed glossary URL from optimism.io to metall2.com.
.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml Updated URLs from optimism.io to metall2.com.
.github/ISSUE_TEMPLATE/suggest_tutorial.yaml Changed URLs from optimism.io to metall2.com.
.github/workflows/links.yml Updated the repository checkout from ethereum-optimism/docs to MetalPay/metal-l2-docs.
.github/workflows/tutorials.yml Deleted the workflow file for checking tutorials.
CONTRIBUTING.md Rebranded from "Optimism" to "Metal L2," updating all relevant references and URLs.
README.md Changed branding from "Optimism Docs" to "Metal L2 Docs," updating URLs and project board links.
components/TokenListTable.tsx Added support for new blockchain networks '1750' and '1740' with their explorer URLs.
next-sitemap.config.js Updated siteUrl from optimism.io to metall2.com.
notes/README.md Changed title and introductory text to reflect Metal L2 branding.
notes/nextra.md Updated title and references from "Optimism" to "Metal L2."
notes/remark.md Changed project name from "Optimism Docs" to "Metal L2 Docs."
package.json Updated project name, version, and description to reflect Metal L2 branding.
pages/_meta.json Renamed sections to reflect Metal L2 terminology and updated titles and URLs.
pages/builders/app-developers/overview.mdx Updated all references from OP Mainnet to Metal L2, including tutorials and descriptions.
pages/builders/cex-wallet-developers/cex-support.mdx Changed references from OP Mainnet to Metal L2 throughout the document.
pages/builders/chain-operators/configuration/batcher.mdx Updated documentation link to MetalLayer2 for version help options.
pages/builders/chain-operators/configuration/proposer.mdx Modified documentation link for version help options to MetalLayer2.
pages/builders/chain-operators/deploy/genesis.mdx Updated links for genesis file generation to MetalLayer2 documentation.
pages/builders/chain-operators/deploy/smart-contracts.mdx Changed release URLs to MetalLayer2 repository.
pages/builders/chain-operators/features/alt-da-mode.mdx Updated links for fee scalar values to the new documentation site.
pages/builders/chain-operators/management/best-practices.mdx Updated links to MetalLayer2 for release information.
pages/builders/chain-operators/tools/op-challenger.mdx Changed release link for op-challenger to MetalLayer2.
pages/builders/node-operators/configuration/consensus-config.mdx Updated documentation link to MetalLayer2 for version help options.
pages/builders/node-operators/releases.mdx Changed release URLs to MetalLayer2 repository.
pages/builders/node-operators/tutorials/node-from-source.mdx Updated release page link to MetalLayer2.
pages/connect/_meta.json Removed "live-support" and "governance" sections.
pages/connect/contribute/_meta.json Updated contribution descriptions to reflect Metal L2 branding.
pages/connect/contribute/docs-contribute.mdx Comprehensive update to reflect rebranding to Metal L2 Docs.
pages/connect/contribute/style-guide.mdx Updated style guide to reflect Metal L2 branding.
pages/connect/resources/_meta.json Updated changelog URL to MetalLayer2.
pages/connect/resources/glossary.mdx Updated terminology and removed specific mentions of "Optimism."
pages/index.mdx Comprehensive update to reflect Metal L2 branding throughout the document.
pages/stack/_meta.json Updated key value from "Getting Started: OP Stack" to "About: OP Stack."
pages/stack/protocol/fault-proofs/challenger.mdx Updated Mermaid diagram color definition.
pages/stack/protocol/rollup/smart-contracts.mdx Changed links to MetalLayer2 for various release notes.
styles/colors.css Updated CSS variable for color --op-red-500.
styles/global.css Various styling adjustments for improved usability.
styles/theme.css Color adjustments and hover effects for various elements.
theme.config.tsx Comprehensive rebranding of the documentation theme.
utils/constants.ts Added new entries for chain IDs 1750 and 1740.
words.txt Adjusted case sensitivity for identifiers and removed some terms.

Possibly related issues

  • #993: The changes in the genesis.mdx file may relate to the overall updates required for deployment documentation.
  • #992: The updates in the smart-contracts.mdx file may connect with the broader changes in deployment processes.
  • #991: The updates in the overview.md file could relate to the overall documentation structure and deployment guidelines.
  • #994: Changes in the best-practices.mdx file may impact the overall documentation structure and best practices for chain operators.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants