Skip to content

Commit 0d81f69

Browse files
sbvegansbvegan
authored
Merge branch 'main' into runbook_links
2 parents ec5ccaa + 682b360 commit 0d81f69

File tree

245 files changed

+6493
-6528
lines changed

Some content is hidden

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

245 files changed

+6493
-6528
lines changed

‎components/WipCallout.tsx‎

Lines changed: 17 additions & 5 deletions
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‎

Lines changed: 2 additions & 1 deletion
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‎

Lines changed: 36 additions & 0 deletions
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

‎package.json‎

Lines changed: 1 addition & 0 deletions
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",

‎pages/_meta.json‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 20 additions & 0 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 28 additions & 0 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 21 additions & 0 deletions
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>

0 commit comments

Comments
 (0)