Skip to content

Commit 3c9da76

Browse files
krofaxkrofax
authored
Merge pull request #1001 from ethereum-optimism/breadcrumbs
Fix Breadcrumbs on Desktop and Mobile
2 parents 4985b95 + c502be9 commit 3c9da76

Some content is hidden

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

48 files changed

+1041
-1
lines changed

‎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/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/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/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>

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Contracts
3+
lang: en-US
4+
description: >-
5+
Information on Solidity compatibility, contract optimization, and system
6+
contracts for OP Stack.
7+
---
8+
9+
import { Card, Cards } from 'nextra/components'
10+
11+
# Contracts
12+
13+
This section provides information on Solidity compatibility, contract optimization on OP Stack, and using OP Stack system contracts. You'll find guides and tutorials to help you understand and work with these topics.
14+
15+
<Cards>
16+
<Card title="Solidity Compatibility" href="/builders/app-developers/contracts/compatibility" />
17+
18+
<Card title="Contract Optimization on OP Stack" href="/builders/app-developers/contracts/optimization" />
19+
20+
<Card title="Using OP Stack System Contracts" href="/builders/app-developers/contracts/system-contracts" />
21+
</Cards>

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Tools
3+
lang: en-US
4+
description: Information on open-source code repositories for OP Stack builders and SuperSim.
5+
---
6+
7+
import { Card, Cards } from 'nextra/components'
8+
9+
# Tools
10+
11+
This section provides information on open-source code repositories for OP Stack builders and SuperSim. Users will find references to help understand and work with these topics.
12+
13+
<Cards>
14+
<Card title="Open-Source Code Repository for OP Stack Builders" href="/builders/app-developers/tools/ecosystem-overview" />
15+
16+
<Card title="SuperSim" href="/builders/app-developers/tools/supersim" />
17+
</Cards>

‎pages/builders/app-developers/tools/supersim.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
---
2+
title: Supersim
3+
lang: en-US
4+
description: >-
5+
Learn about supersim in the Optimism ecosystem. This guide provides detailed
6+
information and resources about supersim.
27
---
38

49
import Supersim from '@/pages/stack/interop/supersim.mdx'

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Transactions
3+
lang: en-US
4+
description: >-
5+
Guide to understanding and working with transactions on OP Stack, including
6+
fee estimation, gas parameters, and troubleshooting.
7+
---
8+
9+
import { Card, Cards } from 'nextra/components'
10+
11+
# Transactions
12+
13+
This section provides information on transactions in OP Mainnet, including fee estimation, gas parameters, transaction statuses, and troubleshooting. You'll find guides to help you understand and work with these topics.
14+
15+
<Cards>
16+
<Card title="Estimating Transaction Fees on OP Mainnet" href="/builders/app-developers/transactions/estimates" />
17+
18+
<Card title="Understanding Fees on OP Mainnet" href="/builders/app-developers/transactions/fees" />
19+
20+
<Card title="Setting Transaction Gas Parameters on OP Mainnet" href="/builders/app-developers/transactions/parameters" />
21+
22+
<Card title="Transaction Statuses on OP Mainnet" href="/builders/app-developers/transactions/statuses" />
23+
24+
<Card title="Troubleshooting Transactions on OP Mainnet" href="/builders/app-developers/transactions/troubleshooting" />
25+
</Cards>

0 commit comments

Comments
 (0)