Skip to content

Commit b458819

Browse files
krofaxkrofax
committed
fix merge conflict
2 parents 491a34d + 1551aa1 commit b458819

File tree

251 files changed

+4476
-3187
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

251 files changed

+4476
-3187
lines changed

‎.coderabbit.yaml

+7-3
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,14 @@ reviews:
1414
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
1515
- Ensure proper nouns are capitalized in sentences.
1616
- Apply the Oxford comma.
17-
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
17+
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
1818
- Use correct spelling and grammar at all times (IMPORTANT).
19-
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
20-
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
19+
- For H1, H2, and H3 headers:
20+
1. Use sentence case, capitalizing only the first word.
21+
2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
22+
3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
23+
- Flag any headers that seem to inconsistently apply these rules for manual review.
24+
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
2125
"
2226
auto_review:
2327
enabled: true

‎.github/workflows/tutorials.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ concurrency:
1010
cancel-in-progress: false
1111

1212
jobs:
13-
cross-dom-bridge-erc20:
13+
cross-dom-bridge-eth:
1414
runs-on: ubuntu-latest
1515

1616
steps:
@@ -32,7 +32,7 @@ jobs:
3232
env:
3333
TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }}
3434
run:
35-
node ./public/tutorials/cross-dom-bridge-erc20.js
35+
node ./public/tutorials/cross-dom-bridge-eth.js
3636

3737
- name: Notify Slack on failure
3838
uses: ravsamhq/notify-slack-action@v2
@@ -47,8 +47,8 @@ jobs:
4747
env:
4848
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
4949

50-
cross-dom-bridge-eth:
51-
needs: cross-dom-bridge-erc20
50+
send-tx-from-eth:
51+
needs: cross-dom-bridge-eth
5252
runs-on: ubuntu-latest
5353

5454
steps:
@@ -70,7 +70,7 @@ jobs:
7070
env:
7171
TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }}
7272
run:
73-
node ./public/tutorials/cross-dom-bridge-eth.js
73+
node ./public/tutorials/send-tx-from-eth.js
7474

7575
- name: Notify Slack on failure
7676
uses: ravsamhq/notify-slack-action@v2
@@ -86,7 +86,7 @@ jobs:
8686
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
8787

8888
sdk-estimate-costs:
89-
needs: cross-dom-bridge-eth
89+
needs: send-tx-from-eth
9090
runs-on: ubuntu-latest
9191

9292
steps:

‎components/WipCallout.tsx

+17-5
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,21 @@ export function InfoCallout({ context }: Props): ReactElement {
7373
);
7474
}
7575

76-
export function AltCallout({ context }: Props): ReactElement {
76+
interface BetaCalloutProps extends Props {
77+
featureName: string;
78+
}
79+
80+
function BetaCallout({ context, featureName }: BetaCalloutProps): ReactElement {
7781
return (
7882
<div className="custom-callouts nx-w-full nx-mt-6 nx-flex nx-justify-center nx-items-center nx-bg-white dark:nx-bg-black">
79-
<div className="nx-w-full nx-px-4 nx-text-center nx-font-medium nx-text-sm nx-text-left">
83+
<div className="nx-w-full nx-px-4 nx-text-center nx-font-medium nx-text-sm nx-text-left">
8084
{context ? (
8185
context
8286
) : (
83-
<div className="nx-text-left">
84-
The Alt-DA Mode feature is currently in <strong>Beta</strong> within
87+
<div className="nx-text-left" role="alert" aria-live="polite">
88+
The {featureName} feature is currently in <strong>Beta</strong> within
8589
the MIT-licensed OP Stack. Beta features are built and reviewed by
86-
the Optimism Collective’s core contributors, and provide developers
90+
the Optimism Collective's core contributors, and provide developers
8791
with early access to highly requested configurations. These features
8892
may experience stability issues, and we encourage feedback from our
8993
early users.
@@ -93,3 +97,11 @@ export function AltCallout({ context }: Props): ReactElement {
9397
</div>
9498
);
9599
}
100+
101+
export function AltCallout(props: Props): ReactElement {
102+
return <BetaCallout {...props} featureName="Alt-DA Mode" />;
103+
}
104+
105+
export function CGTCallout(props: Props): ReactElement {
106+
return <BetaCallout {...props} featureName="Custom Gas Token" />;
107+
}

‎lychee.toml

+2-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ exclude = [
3636
'https://archive.org',
3737
'https://web.archive.org',
3838
'https://mainnet.base.org',
39-
'https://sepolia.base.org'
39+
'https://sepolia.base.org',
40+
'https://optimism.easscan.org'
4041
]
4142

4243
# Accept these status codes

‎notes/breadcrumbs.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Documentation Breadcrumbs Script
2+
3+
Quick guide on using our breadcrumbs automation script for the OP Stack documentation.
4+
5+
## What the Script Does
6+
7+
* Creates `.mdx` files for each folder (breadcrumb pages)
8+
* Populates Card components linking to contained files
9+
* Preserves existing descriptions that already
10+
* Maintains consistent navigation structure
11+
12+
## Using the Script
13+
14+
Breadcrumbs for the docs can be generated by running:
15+
16+
```bash
17+
pnpm create-breadcrumbs
18+
```
19+
20+
### What to Watch For
21+
22+
1. **Before Running**
23+
* Commit your current changes
24+
* Ensure you're in the docs root directory
25+
* Target folders should exist: `builders`, `chain`, `stack`, `connect`
26+
27+
2. **After Running**
28+
* Review generated `.mdx` files in each folder
29+
* Check updated descriptions
30+
* Verify Card components and links
31+
32+
## Common Issues
33+
34+
* ***Script fails**: Ensure you're in the root directory
35+
* **No files generated**: Check folder structure matches expected paths
36+
* **Unexpected content**: Review git diff before committing

‎nouns.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Optimism
2+
OP Mainnet
3+
Ethereum
4+
OP Stack
5+
MetaMask

‎package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"spellcheck:lint": "cspell lint \"**/*.mdx\"",
99
"spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
1010
"linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"",
11+
"create-breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumbs.ts",
1112
"index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",
1213
"dev": "next dev",
1314
"build": "next build",
@@ -28,7 +29,8 @@
2829
"nextra-theme-docs": "2.13.2",
2930
"react": "^18.2.0",
3031
"react-dom": "^18.2.0",
31-
"search-insights": "^2.15.0"
32+
"search-insights": "^2.15.0",
33+
"viem": "^2.21.18"
3234
},
3335
"devDependencies": {
3436
"@double-great/remark-lint-alt-text": "^1.0.0",

‎pages/_meta.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"index": {
3-
"title": "Getting Started",
3+
"title": "Getting started",
44
"display": "hidden",
55
"theme": {
66
"breadcrumb": false,
@@ -38,13 +38,13 @@
3838
},
3939

4040
"faucet": {
41-
"title": "Superchain Faucet",
41+
"title": "Superchain faucet",
4242
"type": "page",
4343
"href": "https://console.optimism.io/faucet?utm_source=docs",
4444
"newWindow": true
4545
},
4646
"gas": {
47-
"title": "Gas Tracker",
47+
"title": "Gas tracker",
4848
"type": "page",
4949
"href": "https://optimistic.grafana.net/public-dashboards/c84a5a9924fe4e14b270a42a8651ceb8?orgId=1&refresh=5m",
5050
"newWindow": true

‎pages/builders.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Builders
3+
lang: en-US
4+
description: Learn about deploying contracts, cross-chain messaging, and tutorials to help you build applications on OP Mainnet.
5+
---
6+
7+
import { Card, Cards } from 'nextra/components'
8+
9+
# Builders
10+
11+
Welcome to the Builders section. Here you'll find resources and guides for developers, operators, and other stakeholders involved in building on OP Stack. Explore the categories below to find the information you need.
12+
13+
<Cards>
14+
<Card title="Notices" href="/builders/notices" />
15+
<Card title="App Developers" href="/builders/app-developers" />
16+
<Card title="Chain Operators" href="/builders/chain-operators" />
17+
<Card title="Node Operators" href="/builders/node-operators" />
18+
<Card title="Wallets & CEXs" href="/builders/cex-wallet-developers" />
19+
<Card title="Developer Tools" href="/builders/tools" />
20+
</Cards>

‎pages/builders/_meta.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"notices": "Notices (README)",
3-
"app-developers": "App Developers",
4-
"chain-operators": "Chain Operators",
5-
"node-operators": "Node Operators",
3+
"app-developers": "App developers",
4+
"chain-operators": "Chain operators",
5+
"node-operators": "Node operators",
66
"cex-wallet-developers": "Wallets & CEXs",
7-
"tools": "Developer Tools"
7+
"tools": "Developer tools"
88
}

‎pages/builders/app-developers.mdx

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: App Developers
3+
lang: en-US
4+
description: Essential resources for app developers building on the OP Stack, including guides for deploying contracts, handling transactions, and cross-chain messaging.
5+
---
6+
7+
import { Card, Cards } from 'nextra/components'
8+
9+
# App Developers
10+
11+
Welcome to the App Developers section, where you'll find essential resources for deploying contracts, handling transactions, cross-chain messaging, and more.
12+
Access quick-start guides, tutorials, and tools to help you build applications on the OP Stack efficiently
13+
14+
<Cards>
15+
<Card title="Overview" href="/builders/app-developers/overview" />
16+
17+
<Card title="Superchain App Quick Start" href="/builders/app-developers/quick-start" />
18+
19+
<Card title="Tutorials" href="/builders/app-developers/tutorials" />
20+
21+
<Card title="Smart Contracts" href="/builders/app-developers/contracts" />
22+
23+
<Card title="Transactions" href="/builders/app-developers/transactions" />
24+
25+
<Card title="Bridging" href="/builders/app-developers/bridging" />
26+
27+
<Card title="App Tools" href="/builders/app-developers/tools" />
28+
</Cards>

‎pages/builders/app-developers/_meta.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"overview": "Overview",
3-
"quick-start": "Superchain App Quick Start",
3+
"quick-start": "Superchain app quick start",
44
"tutorials": "Tutorials",
5-
"contracts": "Smart Contracts",
5+
"contracts": "Smart contracts",
66
"transactions": "Transactions",
77
"bridging": "Bridging",
8-
"tools": "App Tools"
8+
"tools": "App tools"
99
}

‎pages/builders/app-developers/bridging.mdx

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Bridging
3+
lang: en-US
4+
description: Learn about bridging basics, custom bridges, data transmission between L1 and L2, and using the standard bridge in OP Stack.
5+
---
6+
7+
import { Card, Cards } from 'nextra/components'
8+
9+
# Bridging
10+
11+
This section provides information on bridging basics, custom bridges, sending data between l1 and l2 and using the standard bridge. You'll find guide, overview to help you understand and work with these topics.
12+
13+
<Cards>
14+
<Card title="Bridging basics" href="/builders/app-developers/bridging/basics" />
15+
16+
<Card title="Custom bridges" href="/builders/app-developers/bridging/custom-bridge" />
17+
18+
<Card title="Sending data between l1 and l2" href="/builders/app-developers/bridging/messaging" />
19+
20+
<Card title="Using the standard bridge" href="/builders/app-developers/bridging/standard-bridge" />
21+
</Cards>

‎pages/builders/app-developers/bridging/_meta.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"basics": "Basics of Bridging",
2+
"basics": "Basics of bridging",
33
"standard-bridge": "The Standard Bridge",
4-
"custom-bridge": "Custom Token Bridges",
5-
"messaging": "Sending Data Between L1 and L2"
4+
"custom-bridge": "Custom token bridges",
5+
"messaging": "Sending data between L1 and L2"
66
}

‎pages/builders/app-developers/bridging/basics.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: Bridging Basics
2+
title: Bridging basics
33
lang: en-US
44
description: Learn about the fundamentals of sending data and tokens between Ethereum and OP Mainnet.
55
---
66

7-
# Bridging Basics
7+
# Bridging basics
88

99
OP Mainnet is a "Layer 2" system and is fundamentally connected to Ethereum.
1010
However, OP Mainnet is also a distinct blockchain with its own blocks and transactions.
1111
App developers commonly need to move data and tokens between OP Mainnet and Ethereum.
1212
This process of moving data and tokens between the two networks is called "bridging".
1313

14-
## Sending Tokens
14+
## Sending tokens
1515

1616
One of the most common use cases for bridging is the need to send ETH or ERC-20 tokens between OP Mainnet and Ethereum.
1717
OP Mainnet has a system called the [Standard Bridge](./standard-bridge) that makes it easy to move tokens in both directions.
1818
If you mostly need to bridge tokens, make sure to check out the [Standard Bridge](./standard-bridge) guide.
1919

20-
## Sending Data
20+
## Sending data
2121

2222
Under the hood, the Standard Bridge is just an application that uses the OP Mainnet [message passing system to send arbitrary data between Ethereum and OP Mainnet](./messaging).
2323
Applications can use this system to have a contract on Ethereum interact with a contract on OP Mainnet, and vice versa.
2424
All of this is easily accessible with a simple, clean API.
2525

26-
## Next Steps
26+
## Next steps
2727

2828
Ready to start bridging?
2929
Check out these tutorials to get up to speed fast.

‎pages/builders/app-developers/bridging/custom-bridge.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Custom Bridges
2+
title: Custom bridges
33
lang: en-US
44
description: Important considerations when building custom bridges for OP Mainnet.
55
---
66

77
import { Callout } from 'nextra/components'
88

9-
# Custom Bridges
9+
# Custom bridges
1010

1111
Custom token bridges are any bridges other than the [Standard Bridge](./standard-bridge).
1212
You may find yourself in a position where you need to build a custom token bridge because the Standard Bridge doesn't completely support your use case.
@@ -35,7 +35,7 @@ The [Superchain Token List](/chain/tokenlist) exists to help users and developer
3535
Once you've built and tested your custom bridge, make sure to register any tokens meant to flow through this bridge by [making a pull request against the Superchain Token List repository](https://github.com/ethereum-optimism/ethereum-optimism.github.io#adding-a-token-to-the-list).
3636
You **must** deploy your bridge to OP Sepolia before it can be added to the Superchain Token List.
3737

38-
## Next Steps
38+
## Next steps
3939

4040
You can explore several examples of custom bridges for OP Mainnet:
4141

0 commit comments

Comments
 (0)