-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1001 from ethereum-optimism/breadcrumbs
Fix Breadcrumbs on Desktop and Mobile
- Loading branch information
Showing
48 changed files
with
1,041 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Documentation Breadcrumbs Script | ||
|
|
||
| Quick guide on using our breadcrumbs automation script for the OP Stack documentation. | ||
|
|
||
| ## What the Script Does | ||
|
|
||
| * Creates `.mdx` files for each folder (breadcrumb pages) | ||
| * Populates Card components linking to contained files | ||
| * Preserves existing descriptions that already | ||
| * Maintains consistent navigation structure | ||
|
|
||
| ## Using the Script | ||
|
|
||
| Breadcrumbs for the docs can be generated by running: | ||
|
|
||
| ```bash | ||
| pnpm create-breadcrumbs | ||
| ``` | ||
|
|
||
| ### What to Watch For | ||
|
|
||
| 1. **Before Running** | ||
| * Commit your current changes | ||
| * Ensure you're in the docs root directory | ||
| * Target folders should exist: `builders`, `chain`, `stack`, `connect` | ||
|
|
||
| 2. **After Running** | ||
| * Review generated `.mdx` files in each folder | ||
| * Check updated descriptions | ||
| * Verify Card components and links | ||
|
|
||
| ## Common Issues | ||
|
|
||
| * ***Script fails**: Ensure you're in the root directory | ||
| * **No files generated**: Check folder structure matches expected paths | ||
| * **Unexpected content**: Review git diff before committing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: Builders | ||
| lang: en-US | ||
| description: Learn about deploying contracts, cross-chain messaging, and tutorials to help you build applications on OP Mainnet. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Builders | ||
|
|
||
| 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. | ||
|
|
||
| <Cards> | ||
| <Card title="Notices" href="/builders/notices" /> | ||
| <Card title="App Developers" href="/builders/app-developers" /> | ||
| <Card title="Chain Operators" href="/builders/chain-operators" /> | ||
| <Card title="Node Operators" href="/builders/node-operators" /> | ||
| <Card title="Wallets & CEXs" href="/builders/cex-wallet-developers" /> | ||
| <Card title="Developer Tools" href="/builders/tools" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: App Developers | ||
| lang: en-US | ||
| description: Essential resources for app developers building on the OP Stack, including guides for deploying contracts, handling transactions, and cross-chain messaging. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # App Developers | ||
|
|
||
| Welcome to the App Developers section, where you'll find essential resources for deploying contracts, handling transactions, cross-chain messaging, and more. | ||
| Access quick-start guides, tutorials, and tools to help you build applications on the OP Stack efficiently | ||
|
|
||
| <Cards> | ||
| <Card title="Overview" href="/builders/app-developers/overview" /> | ||
|
|
||
| <Card title="Superchain App Quick Start" href="/builders/app-developers/quick-start" /> | ||
|
|
||
| <Card title="Tutorials" href="/builders/app-developers/tutorials" /> | ||
|
|
||
| <Card title="Smart Contracts" href="/builders/app-developers/contracts" /> | ||
|
|
||
| <Card title="Transactions" href="/builders/app-developers/transactions" /> | ||
|
|
||
| <Card title="Bridging" href="/builders/app-developers/bridging" /> | ||
|
|
||
| <Card title="App Tools" href="/builders/app-developers/tools" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Bridging | ||
| 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 | ||
|
|
||
| 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. | ||
|
|
||
| <Cards> | ||
| <Card title="Bridging basics" href="/builders/app-developers/bridging/basics" /> | ||
|
|
||
| <Card title="Custom bridges" href="/builders/app-developers/bridging/custom-bridge" /> | ||
|
|
||
| <Card title="Sending data between l1 and l2" href="/builders/app-developers/bridging/messaging" /> | ||
|
|
||
| <Card title="Using the standard bridge" href="/builders/app-developers/bridging/standard-bridge" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Contracts | ||
| lang: en-US | ||
| description: >- | ||
| Information on Solidity compatibility, contract optimization, and system | ||
| contracts for OP Stack. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Contracts | ||
|
|
||
| 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. | ||
|
|
||
| <Cards> | ||
| <Card title="Solidity Compatibility" href="/builders/app-developers/contracts/compatibility" /> | ||
|
|
||
| <Card title="Contract Optimization on OP Stack" href="/builders/app-developers/contracts/optimization" /> | ||
|
|
||
| <Card title="Using OP Stack System Contracts" href="/builders/app-developers/contracts/system-contracts" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Tools | ||
| lang: en-US | ||
| description: Information on open-source code repositories for OP Stack builders and SuperSim. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Tools | ||
|
|
||
| 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. | ||
|
|
||
| <Cards> | ||
| <Card title="Open-Source Code Repository for OP Stack Builders" href="/builders/app-developers/tools/ecosystem-overview" /> | ||
|
|
||
| <Card title="SuperSim" href="/builders/app-developers/tools/supersim" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Transactions | ||
| lang: en-US | ||
| description: >- | ||
| Guide to understanding and working with transactions on OP Stack, including | ||
| fee estimation, gas parameters, and troubleshooting. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Transactions | ||
|
|
||
| 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. | ||
|
|
||
| <Cards> | ||
| <Card title="Estimating Transaction Fees on OP Mainnet" href="/builders/app-developers/transactions/estimates" /> | ||
|
|
||
| <Card title="Understanding Fees on OP Mainnet" href="/builders/app-developers/transactions/fees" /> | ||
|
|
||
| <Card title="Setting Transaction Gas Parameters on OP Mainnet" href="/builders/app-developers/transactions/parameters" /> | ||
|
|
||
| <Card title="Transaction Statuses on OP Mainnet" href="/builders/app-developers/transactions/statuses" /> | ||
|
|
||
| <Card title="Troubleshooting Transactions on OP Mainnet" href="/builders/app-developers/transactions/troubleshooting" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: Tutorials | ||
| lang: en-US | ||
| description: A collection of tutorials for app developers building on OP Stack, covering topics such as bridging tokens, deploying contracts, and estimating transaction costs. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Tutorials | ||
|
|
||
| This section provides information on bridging erc 20 tokens to op mainnet with the optimism sdk, bridging eth to op mainnet with the optimism sdk, communicating between op mainnet and ethereum in solidity, deploying your first contract on op mainnet, estimating transaction costs on op mainnet, tracing deposits and withdrawals, viewing deposits and withdrawals by address, triggering op mainnet transactions from ethereum, bridging your custom erc 20 token using the standard bridge and bridging your standard erc 20 token using the standard bridge. You'll find tutorial to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Bridging erc 20 tokens to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" /> | ||
|
|
||
| <Card title="Bridging eth to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" /> | ||
|
|
||
| <Card title="Communicating between op mainnet and ethereum in solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" /> | ||
|
|
||
| <Card title="Deploying your first contract on op mainnet" href="/builders/app-developers/tutorials/first-contract" /> | ||
|
|
||
| <Card title="Estimating transaction costs on op mainnet" href="/builders/app-developers/tutorials/sdk-estimate-costs" /> | ||
|
|
||
| <Card title="Tracing deposits and withdrawals" href="/builders/app-developers/tutorials/sdk-trace-txns" /> | ||
|
|
||
| <Card title="Viewing deposits and withdrawals by address" href="/builders/app-developers/tutorials/sdk-view-txns" /> | ||
|
|
||
| <Card title="Triggering op mainnet transactions from ethereum" href="/builders/app-developers/tutorials/send-tx-from-eth" /> | ||
|
|
||
| <Card title="Bridging your custom erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-custom-token" /> | ||
|
|
||
| <Card title="Bridging your standard erc 20 token using the standard bridge" href="/builders/app-developers/tutorials/standard-bridge-standard-token" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: CEX Wallet Developers | ||
| description: >- | ||
| This section provides information on supporting OP Stack in your exchange and | ||
| supporting OP Stack in your wallet. You'll find guide to help you... | ||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # CEX Wallet Developers | ||
|
|
||
| This section provides information on supporting op mainnet in your exchange and supporting op mainnet in your wallet. You'll find guide to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Supporting op mainnet in your exchange" href="/builders/cex-wallet-developers/cex-support" /> | ||
|
|
||
| <Card title="Supporting op mainnet in your wallet" href="/builders/cex-wallet-developers/wallet-support" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: Chain Operators | ||
| lang: en-US | ||
| description: Information on chain architecture, configuration, deployment, and management for OP Stack chain operators. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Chain operators | ||
|
|
||
| This section provides information on chain architecture, configuration, deployment, features, hacks, management, and how to start a self-hosted chain. You'll also find tools, APIs, overviews, guides, and introductions to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Chain architecture" href="/builders/chain-operators/architecture" /> | ||
|
|
||
| <Card title="Configuration" href="/builders/chain-operators/configuration" /> | ||
|
|
||
| <Card title="Deployment" href="/builders/chain-operators/deploy" /> | ||
|
|
||
| <Card title="Features" href="/builders/chain-operators/features" /> | ||
|
|
||
| <Card title="Hacks" href="/builders/chain-operators/hacks" /> | ||
|
|
||
| <Card title="Management" href="/builders/chain-operators/management" /> | ||
|
|
||
| <Card title="How to Start a Self-Hosted Chain" href="/builders/chain-operators/self-hosted" /> | ||
|
|
||
| <Card title="Tools" href="/builders/chain-operators/tools" /> | ||
|
|
||
| <Card title="Tutorials" href="/builders/chain-operators/tutorials" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Configuration | ||
| lang: en-US | ||
| description: Overview of configuration options for batchers, chain operators, proposers, and rollup deployments. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Configuration | ||
|
|
||
| This section provides information on batcher configuration, chain operator configurations, proposer configuration, and rollup deployment configuration. Users will find API references and overviews to help understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Batcher configuration" href="/builders/chain-operators/configuration/batcher" /> | ||
|
|
||
| <Card title="Chain operator configurations" href="/builders/chain-operators/configuration/overview" /> | ||
|
|
||
| <Card title="Proposer configuration" href="/builders/chain-operators/configuration/proposer" /> | ||
|
|
||
| <Card title="Rollup deployment configuration" href="/builders/chain-operators/configuration/rollup" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Deploy | ||
| lang: en-US | ||
| description: Information on OP Stack genesis creation, deployment overview, and smart contract deployment. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Deploy | ||
|
|
||
| This section provides information on OP Stack genesis creation, deployment overview, and smart contract deployment. You'll find guides and overviews to help you understand and work with these topics. | ||
|
|
||
| <Cards> | ||
| <Card title="Op stack genesis creation" href="/builders/chain-operators/deploy/genesis" /> | ||
|
|
||
| <Card title="Op stack deployment overview" href="/builders/chain-operators/deploy/overview" /> | ||
|
|
||
| <Card title="Op stack smart contract deployment" href="/builders/chain-operators/deploy/smart-contracts" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Features | ||
| lang: en-US | ||
| description: >- | ||
| Learn about features in the Optimism ecosystem. This guide provides detailed | ||
| information and resources about features. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Features | ||
|
|
||
| This section provides information on various features for chain operators. You'll find guides and overviews to help you understand and work with topics such as running an alternative data availability mode chain, implementing the bridged USDC standard on the OP Stack, running a custom gas token chain, OP Stack preinstalls, and span batches. | ||
|
|
||
| <Cards> | ||
| <Card title="How to run an alt Da mode chain" href="/builders/chain-operators/features/alt-da-mode" /> | ||
|
|
||
| <Card title="Bridged usdc standard on the op stack" href="/builders/chain-operators/features/bridged-usdc-standard" /> | ||
|
|
||
| <Card title="How to run a custom gas token chain" href="/builders/chain-operators/features/custom-gas-token" /> | ||
|
|
||
| <Card title="Op stack preinstalls" href="/builders/chain-operators/features/preinstalls" /> | ||
|
|
||
| <Card title="Span batches" href="/builders/chain-operators/features/span-batches" /> | ||
| </Cards> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: Hacks | ||
| lang: en-US | ||
| description: >- | ||
| Learn about hacks in the Optimism ecosystem. This guide provides detailed | ||
| information and resources about hacks. | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Hacks | ||
|
|
||
| This section provides information on various types of hacks related to OP Stack, including data availability, derivation, execution, and settlement. You'll find an overview and introduction to help you understand and work with these topics, as well as featured hacks for practical examples. | ||
|
|
||
| <Cards> | ||
| <Card title="Data availability hacks" href="/builders/chain-operators/hacks/data-availability" /> | ||
|
|
||
| <Card title="Derivation hacks" href="/builders/chain-operators/hacks/derivation" /> | ||
|
|
||
| <Card title="Execution hacks" href="/builders/chain-operators/hacks/execution" /> | ||
|
|
||
| <Card title="Featured hacks" href="/builders/chain-operators/hacks/featured-hacks" /> | ||
|
|
||
| <Card title="Introduction to op stack hacks" href="/builders/chain-operators/hacks/overview" /> | ||
|
|
||
| <Card title="Settlement hacks" href="/builders/chain-operators/hacks/settlement" /> | ||
| </Cards> |
Oops, something went wrong.