Skip to content

Commit

Permalink
fix merge conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
krofax committed Feb 11, 2025
2 parents a864e58 + 86b2e35 commit 5789db6
Show file tree
Hide file tree
Showing 249 changed files with 3,943 additions and 1,661 deletions.
3 changes: 3 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ commands:
- restore_cache:
keys:
- v1-pnpm-cache-{{ checksum "pnpm-lock.yaml" }}
- run:
name: Set up pnpm global bin directory
command: pnpm setup # Run setup to configure the global bin directory
- run:
name: Install dependencies
command: npm install -g pnpm && pnpm install
Expand Down
10 changes: 5 additions & 5 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
* @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
/pages/app-developers/tools/connect/rpc-providers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/app-developers/tools/build/block-explorers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/app-developers/tools/build/oracles.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/app-developers/chain-operators/features/alt-da-mode.mdx @ethereum-optimism/docs-reviewers @0xmariniere
/pages/app-developers/tools/build/account-abstraction.mdx @ethereum-optimism/docs-reviewers @0xmariniere
2 changes: 1 addition & 1 deletion .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.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/operators/chain-operators/management/troubleshooting).
- type: markdown
id: project_info
attributes:
Expand Down
23 changes: 22 additions & 1 deletion components/AskAIButton.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,36 @@
import { RiSparkling2Fill } from '@remixicon/react';
import { useFeature } from '@growthbook/growthbook-react';
import { useEffect, useState } from 'react';

const AskAIButton = () => {
const [mounted, setMounted] = useState(false);
const enableDocsAIWidget = useFeature('enable_docs_ai_widget').on;

useEffect(() => {
setMounted(true);
}, []);

// Don't render anything until client-side
if (!mounted) {
return null;
}

if (!enableDocsAIWidget) {
return null;
}

return (
<button id='custom-ask-ai-button' className='nx-flex nx-gap-2 nx-items-center nx-py-1.5 nx-px-3 nx-rounded-lg nx-text-sm nx-font-semibold' style={{ backgroundColor: '#FF0420', color: 'white', display: 'flex', alignItems: 'center', gap: '4px' }}>
<button
id='custom-ask-ai-button'
className='nx-flex nx-gap-2 nx-items-center nx-py-1.5 nx-px-3 nx-rounded-lg nx-text-sm nx-font-semibold'
style={{
backgroundColor: '#FF0420',
color: 'white',
display: 'flex',
alignItems: 'center',
gap: '4px'
}}
>
<span>Ask AI</span>
<RiSparkling2Fill size={14} />
</button>
Expand Down
98 changes: 98 additions & 0 deletions components/Footer.tsx

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions components/WipCallout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,8 @@ export function InteropCallout({ context }: Props): ReactElement {
<div className="nx-text-left">
Interop is currently in <strong>active development</strong> and not
yet ready for production use. The information provided here may
change frequently.
<p>
We recommend checking back regularly for the most up-to-date
change frequently. We recommend checking back regularly for the most up-to-date
information.
</p>
</div>
)}
</div>
Expand Down
2 changes: 1 addition & 1 deletion components/calculator/ResultsTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export function ResultsTable({
<p className="calculator-info calculator-text">
<strong>Note: </strong>This is an estimation,{" "}
<a
href="/builders/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
href="/operators/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
target="_blank"
>
read how to determine scalar values using blobs
Expand Down
2 changes: 1 addition & 1 deletion notes/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pnpm fix
1. **Before Running**
* Commit your current changes
* Ensure you're in the docs root directory
* Target folders should exist: `builders`, `chain`, `stack`, `connect`
* Target folders should exist: `app-developers`, `operators`, `stack`, `superchain`

2. **After Running**
* Review generated `.mdx` files in each folder
Expand Down
2 changes: 2 additions & 0 deletions nouns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Ethereum
OP Stack
MetaMask
SuperchainERC20
SuperchainERC20 Starter Kit
Supersim
ZK
Security Council
Sequencer PBS
Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm breadcrumbs && pnpm fix-redirects",
"spellcheck:lint": "cspell lint \"**/*.mdx\"",
"spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
"linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"",
"breadcrumbs": "npx ts-node --skip-project utils/create-breadcrumbs.ts",
"check-redirects": "npx ts-node --skip-project utils/redirects.ts",
"fix-redirects": "npx ts-node --skip-project utils/fix-redirects.ts",
Expand Down Expand Up @@ -63,7 +64,8 @@
"remark-lint-unordered-list-marker-style": "^3.1.2",
"remark-preset-lint-consistent": "^5.1.2",
"remark-preset-lint-recommended": "^6.1.3",
"typescript": "^5.2.2",
"ts-node": "10.9.2",
"typescript": "^5.3.2",
"unified-lint-rule": "^2.1.2",
"unist-util-visit": "^5.0.0"
},
Expand All @@ -74,4 +76,4 @@
"nextra@2.13.2": "patches/nextra@2.13.2.patch"
}
}
}
}
145 changes: 77 additions & 68 deletions pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,88 @@
{
"index": {
"title": "Getting started",
"title": "Home",
"display": "hidden",
"theme": {
"breadcrumb": false,
"footer": true,
"sidebar": false,
"toc": false,
"pagination": false
}
},
"notices": {
"title": "Notices (README)"
},
"+++ Notices": {
"title": "",
"type": "separator"
},

"get-started": {
"title": "Get started",
"type":"page",
"theme": {
"navbar": true,
"sidebar": true,
"toc": true,
"pagination": true
},
"display": "children"
},
"superchain": {
"title": "Superchain",
"type":"page",
"theme": {
"navbar": true,
"sidebar": true,
"toc": true,
"pagination": true
},
"display": "children"
},
"app-developers": {
"title": "App Devs",
"type": "page",
"theme": {
"navbar": true,
"sidebar": true,
"toc": true,
"pagination": true
},
"display": "children"
},
"operators": {
"title": "Operators",
"type": "page",
"theme": {
"navbar": true,
"sidebar": true,
"toc": true,
"pagination": true
},
"display": "children"
},
"stack": {
"title": "OP Stack",
"type": "page",
"theme": {
"navbar": true,
"sidebar": true,
"toc": true,
"pagination": true
},
"display": "children"
},

"connect": {
"title": "Connect",
"type": "page",
"display": "hidden",
"theme": {
"breadcrumb": false,
"footer": true,
"sidebar": true,
"toc": false,
"pagination": false
}
},
Expand Down Expand Up @@ -35,72 +111,5 @@
"toc": false,
"pagination": false
}
},

"faucet": {
"title": "Superchain faucet",
"type": "page",
"href": "https://console.optimism.io/faucet?utm_source=docs",
"newWindow": true
},
"gas": {
"title": "Gas tracker",
"type": "page",
"href": "https://optimistic.grafana.net/public-dashboards/c84a5a9924fe4e14b270a42a8651ceb8?orgId=1&refresh=5m",
"newWindow": true
},
"status": {
"title": "Status",
"type": "page",
"href": "https://status.optimism.io/",
"newWindow": true
},

"--- BUILDERS": {
"title": "BUILDERS",
"type": "separator"
},
"builders": {
"title": "Builders",
"display": "children"
},

"+++ THE SUPERCHAIN": {
"title": "",
"type": "separator"
},
"--- THE SUPERCHAIN": {
"title": "THE SUPERCHAIN",
"type": "separator"
},
"superchain": {
"title": "The Superchain",
"display": "children"
},

"+++ OP STACK": {
"title": "",
"type": "separator"
},
"--- OP STACK": {
"title": "OP STACK",
"type": "separator"
},
"stack": {
"title": "OP Stack",
"display": "children"
},

"+++ CONNECT": {
"title": "",
"type": "separator"
},
"--- CONNECT": {
"title": "CONNECT",
"type": "separator"
},
"connect": {
"title": "Connect",
"display": "children"
}
}
37 changes: 37 additions & 0 deletions pages/app-developers/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"--- App Devs": {
"title": "App Developers",
"type": "separator"
},
"get-started": "Getting started",
"starter-kit": "SuperchainERC20 starter kit",
"interop": "Interoperability",
"building-apps": "Building apps on the Superchain",
"testing-apps": "Testing apps for the Superchain",
"bridging": "Bridging",
"transactions": "Transactions",
"+++ Tutorials": {
"title": "",
"type": "separator"
},
"--- Tutorials": {
"title": "Tutorials",
"type": "separator"
},
"tutorials": {
"title": "Tutorials",
"display": "children"
},
"+++ DevTools": {
"title": "",
"type": "separator"
},
"--- DevTools": {
"title": "Developer tools",
"type": "separator"
},
"tools": {
"title": "Developer tools",
"display": "children"
}
}
24 changes: 24 additions & 0 deletions pages/app-developers/bridging.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Bridging guides
lang: en-US
description: Learn about bridging basics, custom bridges, data transmission between L1 and L2, and using the standard bridge in OP Stack.
---

import { Card, Cards } from 'nextra/components'

# Bridging guides

Looking to build an application that sends ETH, tokens, or data between OP Mainnet and Ethereum?
You'll find some useful guides and tutorials in this area of the docs.
For instance, if you want to learn how to bridge a token from Ethereum to OP Mainnet (or vice versa!), you should check out the [Standard Token Bridge](bridging/standard-bridge).

If you're looking for something more advanced, take a look at the guide on [sending data between L1 and L2](bridging/messaging).
Contracts on one chain can trigger contract functions on the other chain, which is pretty cool!
The Standard Token Bridge for OP Mainnet even uses this same message-passing infrastructure under the hood.

<Cards>
<Card title="Bridging basics" href="/app-developers/bridging/basics" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Standard bridge" href="/app-developers/bridging/standard-bridge" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Custom bridges" href="/app-developers/bridging/custom-bridge" icon={<img src="/img/icons/shapes.svg" />} />
<Card title="Sending data between L1 and L2" href="/app-developers/bridging/messaging" icon={<img src="/img/icons/shapes.svg" />} />
</Cards>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ All of this is easily accessible with a simple, clean API.
Ready to start bridging?
Check out these tutorials to get up to speed fast.

* [Learn how to bridge ERC-20 tokens with viem](/builders/app-developers/tutorials/cross-dom-bridge-erc20)
* [Learn how to bridge ETH with viem](/builders/app-developers/tutorials/cross-dom-bridge-eth)
* [Learn how to create a standard bridged token](/builders/app-developers/tutorials/standard-bridge-standard-token)
* [Learn how to create a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token)
* [Learn how to bridge ERC-20 tokens with viem](/app-developers/tutorials/bridging/cross-dom-bridge-erc20)
* [Learn how to bridge ETH with viem](/app-developers/tutorials/bridging/cross-dom-bridge-eth)
* [Learn how to create a standard bridged token](/app-developers/tutorials/bridging/standard-bridge-standard-token)
* [Learn how to create a custom bridged token](/app-developers/tutorials/bridging/standard-bridge-custom-token)
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide provides important information you should be aware of when building a
<Callout>
Custom bridges can bring a significant amount of complexity and risk to any project.
Before you commit to a custom bridge, be sure that the [Standard Bridge](./standard-bridge) definitely does not support your use case.
[Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility.
[Building a custom bridged token](/app-developers/tutorials/bridging/standard-bridge-custom-token) is often sufficient for projects that need more flexibility.
</Callout>

## Guidelines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This page explains how bridging works, how to use it, and what to watch out for.

<Callout type="info">
This is a high-level overview of the bridging process.
For a step-by-step tutorial on how to send data between L1 and L2, check out the [Solidity tutorial](/builders/app-developers/tutorials/cross-dom-solidity).
For a step-by-step tutorial on how to send data between L1 and L2, check out the [Solidity tutorial](/app-developers/tutorials/bridging/cross-dom-solidity).
</Callout>

## Understanding contract calls
Expand Down
Loading

0 comments on commit 5789db6

Please sign in to comment.