Skip to content

Commit 3a0a9bb

Browse files
krofaxkrofax
committed
fix conflict
2 parents 36fea13 + 442f4c6 commit 3a0a9bb

File tree

162 files changed

+4467
-2437
lines changed

Some content is hidden

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

162 files changed

+4467
-2437
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/ISSUE_TEMPLATE/docs_audit_results.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,25 @@ labels: 'docs-audit-2024-Q4,op-labs'
99

1010
## Description of the updates required
1111

12-
> Write a description of the current state of the page.
12+
<!-- Write a description of the current state of the page. -->
13+
14+
### Acceptance criteria
15+
16+
<!-- Definition of done for the assignee -->
17+
18+
### Resources
19+
20+
<!-- Supporting docs, points of contact, and any additional helpful info -->
21+
22+
### Action items
23+
24+
<!-- The process for working through this issue for example:
25+
1. Read through resources and meet with SME
26+
2. Write the first draft
27+
3. Share draft with SMEs and implement feedback
28+
4. Peer review
29+
5. Final SME review
30+
6. Publish -->
1331

1432
## Github issue label criteria
1533

‎.github/workflows/breadcrumbs.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Check Breadcrumbs
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
paths:
9+
- 'pages/**/*.mdx'
10+
- 'pages/**/*.md'
11+
12+
jobs:
13+
check-breadcrumbs:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Check out code
18+
uses: actions/checkout@v2
19+
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v2
22+
with:
23+
node-version: '20.x'
24+
25+
- name: Install pnpm
26+
run: npm install -g pnpm
27+
28+
- name: Install dependencies
29+
run: pnpm install
30+
31+
- name: Run breadcrumb check
32+
run: pnpm check-breadcrumbs

‎.github/workflows/monthly-issue-metircs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ jobs:
4141
token: ${{ secrets.GITHUB_TOKEN }}
4242
content-filepath: ./issue_metrics.md
4343
assignees: sbvegan
44+
labels: |
45+
monthly-report
4446
4547
- name: Run issue-metrics tool for issues last month
4648
uses: github/issue-metrics@v2

‎.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/calculator/ResultsTable.tsx

+3-5
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,11 @@ export function ResultsTable({
108108
<p className="calculator-info calculator-text">
109109
<strong>Note: </strong>This is an estimation,{" "}
110110
<a
111-
href="https://docs.optimism.io/builders/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
111+
href="/builders/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
112112
target="_blank"
113113
>
114-
see the Optimism Docs
115-
</a>{" "}
116-
for steps on modifying parameters if needed once the chain is on
117-
mainnet{" "}
114+
read how to determine scalar values using blobs
115+
</a>
118116
</p>
119117
</div>
120118
<div className="results-table-wrap">

‎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

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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 breadcrumbs
18+
```
19+
20+
* To check files with missing breadcrumbs, run:
21+
22+
```bash
23+
pnpm fix
24+
```
25+
26+
### What to Watch For
27+
28+
1. **Before Running**
29+
* Commit your current changes
30+
* Ensure you're in the docs root directory
31+
* Target folders should exist: `builders`, `chain`, `stack`, `connect`
32+
33+
2. **After Running**
34+
* Review generated `.mdx` files in each folder
35+
* Check updated descriptions, please update the description.
36+
* Verify Card components and links
37+
38+
## Common Issues
39+
40+
* ***Script fails**: Ensure you're in the root directory
41+
* **No files generated**: Check folder structure matches expected paths
42+
* **Unexpected content**: Review git diff before committing

‎nouns.txt

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Optimism
2+
OP Mainnet
3+
Ethereum
4+
OP Stack
5+
MetaMask
6+
SuperchainERC20
7+
ZK
8+
Security Council
9+
Sequencer PBS
10+
Superchain Registry
11+
Retro Funding
12+
Alt-DA
13+
Teleportr
14+
Dev Console
15+
Granite
16+
Holocene
17+
Monitorism
18+
Kubernetes
19+
Fault Proof System
20+
Viem

‎package.json

+6-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
"version": "0.0.1",
44
"description": "Optimism Docs",
55
"scripts": {
6-
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint",
7-
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix",
6+
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs",
7+
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm check-breadcrumbs",
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+
"breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumbs.ts",
12+
"check-breadcrumbs":"npx ts-node --skip-project utils/breadcrumbs.ts",
1113
"index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",
1214
"dev": "next dev",
1315
"build": "next build",
@@ -28,7 +30,8 @@
2830
"nextra-theme-docs": "2.13.2",
2931
"react": "^18.2.0",
3032
"react-dom": "^18.2.0",
31-
"search-insights": "^2.15.0"
33+
"search-insights": "^2.15.0",
34+
"viem": "^2.21.18"
3235
},
3336
"devDependencies": {
3437
"@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

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: App Developers
3+
description: If you're a developer looking to build on OP Stack, you've come to the right place. In this area of the Optimism Docs you'll find everything you ...
4+
lang: en-US
5+
---
6+
7+
import { Card, Cards } from 'nextra/components'
8+
9+
# App Developers
10+
11+
If you're a developer looking to build on OP Mainnet, you've come to the right place. In this area of the Optimism Docs you'll find everything you ...
12+
13+
<Cards>
14+
<Card title="Bridging" href="/builders/app-developers/bridging" />
15+
16+
<Card title="Contracts" href="/builders/app-developers/contracts" />
17+
18+
<Card title="App developer overview" href="/builders/app-developers/overview" />
19+
20+
<Card title="Superchain app quick start" href="/builders/app-developers/quick-start" />
21+
22+
<Card title="Tools" href="/builders/app-developers/tools" />
23+
24+
<Card title="Transactions" href="/builders/app-developers/transactions" />
25+
26+
<Card title="Tutorials" href="/builders/app-developers/tutorials" />
27+
</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
}

0 commit comments

Comments
 (0)