Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Breadcrumbs on Desktop and Mobile #1001

Merged
merged 20 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"spellcheck:lint": "cspell lint \"**/*.mdx\"",
"spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
"linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"",
"create-breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumbs.ts",
"index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",
"dev": "next dev",
"build": "next build",
Expand Down
20 changes: 20 additions & 0 deletions pages/builders.mdx
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

The fixture is the main abstraction in React Cosmos. It represents a component example that can be rendered in isolation. A fixture file is generally colocated with its related component file.

<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>
21 changes: 21 additions & 0 deletions pages/builders/app-developers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---

Check warning on line 1 in pages/builders/app-developers.mdx

View workflow job for this annotation

GitHub Actions / lint

Missing newline character at end of file

Check warning on line 1 in pages/builders/app-developers.mdx

View workflow job for this annotation

GitHub Actions / lint

Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
title: App Developers
lang: en-US
---

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>
17 changes: 17 additions & 0 deletions pages/builders/app-developers/bridging.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---

Check warning on line 1 in pages/builders/app-developers/bridging.mdx

View workflow job for this annotation

GitHub Actions / lint

Missing newline character at end of file

Check warning on line 1 in pages/builders/app-developers/bridging.mdx

View workflow job for this annotation

GitHub Actions / lint

Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
title: Bridging
lang: en-US
---

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>
4 changes: 2 additions & 2 deletions pages/builders/app-developers/bridging/custom-bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide provides important information you should be aware of when building a
<Callout>
Custom bridges can bring a significant amount of complexity and risk to any project.
Before you commit to a custom bridge, be sure that the [Standard Bridge](./standard-bridge) definitely does not support your use case.
[Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility.
[Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-tokennnnyd) is often sufficient for projects that need more flexibility.
</Callout>

## Guidelines
Expand All @@ -27,7 +27,7 @@ Doing so will provide you with an audited foundation upon which you can add extr

If you choose not to extend the `StandardBridge` contract, you may still want to follow the interface that the `StandardBridge` provides.
Bridges that extend this interface will be compatible with the [Superchain Bridges UI](https://app.optimism.io/bridge).
You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridge).
You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridgedgh).

## The Superchain Token List

Expand Down
16 changes: 16 additions & 0 deletions pages/builders/app-developers/contracts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---

Check warning on line 1 in pages/builders/app-developers/contracts.mdx

View workflow job for this annotation

GitHub Actions / lint

Missing newline character at end of file

Check warning on line 1 in pages/builders/app-developers/contracts.mdx

View workflow job for this annotation

GitHub Actions / lint

Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
title: Contracts
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Contracts

This section provides information on solidity compatibility, contract optimization on op mainnet and using op mainnet system contracts. You'll find guide, tutorial 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 mainnet" href="/builders/app-developers/contracts/optimization" />
<Card title="Using op mainnet system contracts" href="/builders/app-developers/contracts/system-contracts" />
</Cards>
15 changes: 15 additions & 0 deletions pages/builders/app-developers/tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---

Check warning on line 1 in pages/builders/app-developers/tools.mdx

View workflow job for this annotation

GitHub Actions / lint

Missing newline character at end of file

Check warning on line 1 in pages/builders/app-developers/tools.mdx

View workflow job for this annotation

GitHub Actions / lint

Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
title: Tools
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Tools

This section provides information on open source code repo for op stack builders and supersim. You'll find reference to help you understand and work with these topics.

<Cards>
<Card title="Open source code repo for op stack builders" href="/builders/app-developers/tools/ecosystem-overview" />
<Card title="Supersim" href="/builders/app-developers/tools/supersim" />
</Cards>
18 changes: 18 additions & 0 deletions pages/builders/app-developers/transactions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---

Check warning on line 1 in pages/builders/app-developers/transactions.mdx

View workflow job for this annotation

GitHub Actions / lint

Missing newline character at end of file

Check warning on line 1 in pages/builders/app-developers/transactions.mdx

View workflow job for this annotation

GitHub Actions / lint

Must have required property 'description' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
title: Transactions
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Transactions

This section provides information on estimating transaction fees on op mainnet, fees, setting transaction gas parameters on op mainnet, transaction statuses on op mainnet and troubleshooting transactions. You'll find guide 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="Fees" 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" href="/builders/app-developers/transactions/troubleshooting" />
</Cards>
23 changes: 23 additions & 0 deletions pages/builders/app-developers/tutorials.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Tutorials
lang: en-US
---

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>
15 changes: 15 additions & 0 deletions pages/builders/cex-wallet-developers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Cex Wallet Developers
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>
22 changes: 22 additions & 0 deletions pages/builders/chain-operators.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Chain Operators
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Chain Operators

This section provides information on chain architecture, configuration, deploy, features, hacks, management, how to start a self hosted chain, tools and tutorials. You'll find tool, api, overview, guide, introduction 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="Deploy" 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>
17 changes: 17 additions & 0 deletions pages/builders/chain-operators/configuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Configuration
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Configuration

This section provides information on batcher configuration, chain operator configurations, proposer configuration and rollup deployment configuration. You'll find api, overview to help you 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>
16 changes: 16 additions & 0 deletions pages/builders/chain-operators/deploy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Deploy
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Deploy

This section provides information on op stack genesis creation, op stack deployment overview and op stack smart contract deployment. You'll find guide, overview 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>
18 changes: 18 additions & 0 deletions pages/builders/chain-operators/features.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Features
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Features

This section provides information on how to run an alt da mode chain, bridged usdc standard on the op stack, how to run a custom gas token chain, op stack preinstalls and span batches. You'll find guide, overview to help you understand and work with these topics.

<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>
19 changes: 19 additions & 0 deletions pages/builders/chain-operators/hacks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Hacks
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Hacks

This section provides information on data availability hacks, derivation hacks, execution hacks, featured hacks, introduction to op stack hacks and settlement hacks. You'll find overview, introduction to help you understand and work with these topics.

<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>
19 changes: 19 additions & 0 deletions pages/builders/chain-operators/management.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Management
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Management

This section provides information on chain operator best practices, using blobs, managing your keys, rollup operations, using snap sync for chain operators and troubleshooting: chain operations. You'll find guide, tutorial to help you understand and work with these topics.

<Cards>
<Card title="Chain operator best practices" href="/builders/chain-operators/management/best-practices" />
<Card title="Using blobs" href="/builders/chain-operators/management/blobs" />
<Card title="Managing your keys" href="/builders/chain-operators/management/key-management" />
<Card title="Rollup operations" href="/builders/chain-operators/management/operations" />
<Card title="Using snap sync for chain operators" href="/builders/chain-operators/management/snap-sync" />
<Card title="Troubleshooting: chain operations" href="/builders/chain-operators/management/troubleshooting" />
</Cards>
18 changes: 18 additions & 0 deletions pages/builders/chain-operators/tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Tools
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Tools

This section provides information on chain monitoring options, deploying a block explorer, how to configure challenger for your chain, conductor and deployer. You'll find guide, overview, tool to help you understand and work with these topics.

<Cards>
<Card title="Chain monitoring options" href="/builders/chain-operators/tools/chain-monitoring" />
<Card title="Deploying a block explorer" href="/builders/chain-operators/tools/explorer" />
<Card title="How to configure challenger for your chain" href="/builders/chain-operators/tools/op-challenger" />
<Card title="Conductor" href="/builders/chain-operators/tools/op-conductor" />
<Card title="Deployer" href="/builders/chain-operators/tools/op-deployer" />
</Cards>
19 changes: 19 additions & 0 deletions pages/builders/chain-operators/tutorials.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Tutorials
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Tutorials

This section provides information on adding attributes to the derivation function, adding a precompile, creating your own l2 rollup testnet, integrating a new da layer with alt da, modifying predeployed contracts and using the optimism sdk. You'll find overview, tutorial, guide to help you understand and work with these topics.

<Cards>
<Card title="Adding attributes to the derivation function" href="/builders/chain-operators/tutorials/adding-derivation-attributes" />
<Card title="Adding a precompile" href="/builders/chain-operators/tutorials/adding-precompiles" />
<Card title="Creating your own l2 rollup testnet" href="/builders/chain-operators/tutorials/create-l2-rollup" />
<Card title="Integrating a new da layer with alt Da" href="/builders/chain-operators/tutorials/integrating-da-layer" />
<Card title="Modifying predeployed contracts" href="/builders/chain-operators/tutorials/modifying-predeploys" />
<Card title="Using the optimism sdk" href="/builders/chain-operators/tutorials/sdk" />
</Cards>
21 changes: 21 additions & 0 deletions pages/builders/node-operators.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Node Operators
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Node Operators

This section provides information on node architecture, configuration, json rpc api, management, network upgrade overview, node software releases, how to run a node in the superchain and tutorials. You'll find api, overview, guide, tutorial to help you understand and work with these topics.

<Cards>
<Card title="Node architecture" href="/builders/node-operators/architecture" />
<Card title="Configuration" href="/builders/node-operators/configuration" />
<Card title="Json Rpc api" href="/builders/node-operators/json-rpc" />
<Card title="Management" href="/builders/node-operators/management" />
<Card title="Network upgrade overview" href="/builders/node-operators/network-upgrades" />
<Card title="Node software releases" href="/builders/node-operators/releases" />
<Card title="How to run a node in the superchain" href="/builders/node-operators/rollup-node" />
<Card title="Tutorials" href="/builders/node-operators/tutorials" />
</Cards>
16 changes: 16 additions & 0 deletions pages/builders/node-operators/configuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Configuration
lang: en-US
---

import { Card, Cards } from 'nextra/components'

# Configuration

This section provides information on node base configuration, consensus layer configuration options (op node) and execution layer configuration options (op geth). You'll find api to help you understand and work with these topics.

<Cards>
<Card title="Node base configuration" href="/builders/node-operators/configuration/base-config" />
<Card title="Consensus layer configuration options (op Node)" href="/builders/node-operators/configuration/consensus-config" />
<Card title="Execution layer configuration options (op Geth)" href="/builders/node-operators/configuration/execution-config" />
</Cards>
Loading
Loading