-
Notifications
You must be signed in to change notification settings - Fork 277
Updated Breadcrumb script #1060
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
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
f0d666c
update breadcrumb script
krofax 2a8ea49
updated breadcrumb notes
krofax 52b93cf
Update notes/breadcrumbs.md
krofax 2595a8f
Update pages/stack/beta-features/beta-features.mdx
krofax 28bc2d9
add workflow
krofax 17e8ff0
fix conflict
krofax cac2458
fix code issues
krofax a3d3a4c
updated the workflow file
krofax 5ced9a3
updated check breadcrumb script
krofax f782dab
updated script
krofax 66d7e38
updated breadcrumbs script
krofax 6633952
updated script file
krofax 149c30b
fix conflict
krofax dc92482
updated breadcrumbs
krofax 8d26531
updated creadcrumbs
krofax 3ac9f42
fix lint issues
krofax e14923f
updated breadcrumb check script
krofax c264bb4
fix lint issues
krofax 1fdff8c
fix lint markdown issues
krofax be06f2d
fix lint issues
krofax File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,32 @@ | ||
| name: Check Breadcrumbs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
| paths: | ||
| - 'pages/**/*.mdx' | ||
| - 'pages/**/*.md' | ||
|
|
||
| jobs: | ||
| check-breadcrumbs: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v2 | ||
| with: | ||
| node-version: '20.x' | ||
|
|
||
| - name: Install pnpm | ||
| run: npm install -g pnpm | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install | ||
|
|
||
| - name: Run breadcrumb check | ||
| run: pnpm check-breadcrumbs | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,28 +1,27 @@ | ||
| --- | ||
| title: App Developers | ||
| 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 ... | ||
| 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 | ||
| 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 ... | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Cards> | ||
| <Card title="Overview" href="/builders/app-developers/overview" /> | ||
| <Card title="Bridging" href="/builders/app-developers/bridging" /> | ||
|
|
||
| <Card title="Superchain App Quick Start" href="/builders/app-developers/quick-start" /> | ||
| <Card title="Contracts" href="/builders/app-developers/contracts" /> | ||
|
|
||
| <Card title="Tutorials" href="/builders/app-developers/tutorials" /> | ||
| <Card title="App developer overview" href="/builders/app-developers/overview" /> | ||
|
|
||
| <Card title="Smart Contracts" href="/builders/app-developers/contracts" /> | ||
| <Card title="Superchain app quick start" href="/builders/app-developers/quick-start" /> | ||
|
|
||
| <Card title="Transactions" href="/builders/app-developers/transactions" /> | ||
| <Card title="Tools" href="/builders/app-developers/tools" /> | ||
|
|
||
| <Card title="Bridging" href="/builders/app-developers/bridging" /> | ||
| <Card title="Transactions" href="/builders/app-developers/transactions" /> | ||
|
|
||
| <Card title="App Tools" href="/builders/app-developers/tools" /> | ||
| <Card title="Tutorials" href="/builders/app-developers/tutorials" /> | ||
| </Cards> | ||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,19 +1,17 @@ | ||
| --- | ||
| 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... | ||
| title: Cex Wallet Developers | ||
| description: Documentation covering Cex Support, Wallet Support in the Cex Wallet Developers section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # CEX Wallet Developers | ||
| # Cex Wallet Developers | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
| Documentation covering Cex Support, Wallet Support in the Cex Wallet Developers section of the OP Stack ecosystem. | ||
|
|
||
| <Cards> | ||
| <Card title="Supporting op mainnet in your exchange" href="/builders/cex-wallet-developers/cex-support" /> | ||
| <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" /> | ||
| <Card title="Supporting OP Mainnet in your wallet" href="/builders/cex-wallet-developers/wallet-support" /> | ||
| </Cards> | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,29 +1,29 @@ | ||
| --- | ||
| title: Node Operators | ||
| description: This section provides information on node architecture, configuration, json rpc api, management, network upgrades, node software releases, how to run... | ||
| description: Documentation covering Architecture, Configuration, Json Rpc, Management, Network Upgrades, Releases, Rollup Node, Tutorials in the Node Operators section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Node Operators | ||
|
|
||
| This section provides information on node architecture, configuration, json rpc api, management, network upgrades, node software releases, how to run a node in the superchain and tutorials. You'll find api, guide, overview to help you understand and work with these topics. | ||
| Documentation covering Architecture, Configuration, Json Rpc, Management, Network Upgrades, Releases, Rollup Node, Tutorials in the Node Operators section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <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="JSON-RPC API" href="/builders/node-operators/json-rpc" /> | ||
|
|
||
| <Card title="Management" href="/builders/node-operators/management" /> | ||
|
|
||
| <Card title="Network upgrades" href="/builders/node-operators/network-upgrades" /> | ||
|
|
||
| <Card title="Node software releases" href="/builders/node-operators/releases" /> | ||
| <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="How to run a node in the Superchain" href="/builders/node-operators/rollup-node" /> | ||
|
|
||
| <Card title="Tutorials" href="/builders/node-operators/tutorials" /> | ||
| </Cards> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,15 +1,15 @@ | ||
| --- | ||
| title: Notices | ||
| description: This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and deprecation of the... | ||
| description: Documentation covering Sdk Deprecation in the Notices section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Notices | ||
|
|
||
| This section offers essential information for builders to stay up-to-date with the latest changes in the OP Stack. | ||
| Documentation covering Sdk Deprecation in the Notices section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Cards> | ||
| <Card title="Deprecation of the optimism sdk" href="/builders/notices/sdk-deprecation" /> | ||
| <Card title="Deprecation of the Optimism SDK" href="/builders/notices/sdk-deprecation" /> | ||
| </Cards> | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,21 +1,19 @@ | ||
| --- | ||
| title: Security | ||
| description: >- | ||
| This section provides information on OP Stack security model, privileged roles | ||
| in OP Stack and security policy and bug bounty program. | ||
| description: Documentation covering Faq, Privileged Roles, Security Policy in the Security section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Security | ||
|
|
||
| This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. | ||
| Documentation covering Faq, Privileged Roles, Security Policy in the Security section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Cards> | ||
| <Card title="Op mainnet security model" href="/chain/security/faq" /> | ||
| <Card title="OP Stack security model" href="/chain/security/faq" /> | ||
|
|
||
| <Card title="Privileged roles in op mainnet" href="/chain/security/privileged-roles" /> | ||
| <Card title="Privileged Roles in OP Stack" href="/chain/security/privileged-roles" /> | ||
|
|
||
| <Card title="Security policy and bug bounty program" href="/chain/security/security-policy" /> | ||
| </Cards> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,19 +1,17 @@ | ||
| --- | ||
| title: Testing | ||
| description: >- | ||
| This section provides information on running a local development environment | ||
| and testing apps for OP Stack. You'll find tutorial, guide to help you... | ||
| description: Documentation covering Dev Node, Testing Apps in the Testing section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Testing | ||
|
|
||
| This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you understand and work with these topics. | ||
| Documentation covering Dev Node, Testing Apps in the Testing section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Cards> | ||
| <Card title="Running a local development environment" href="/chain/testing/dev-node" /> | ||
|
|
||
| <Card title="Testing apps for op mainnet" href="/chain/testing/testing-apps" /> | ||
| <Card title="Testing apps for OP Stack" href="/chain/testing/testing-apps" /> | ||
| </Cards> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,19 +1,17 @@ | ||
| --- | ||
| title: Contribute | ||
| description: This section provides information on ways to contribute to optimism docs, contribute to the op stack and optimism docs style guide. You'll find... | ||
| description: Documentation covering Docs Contribute, Stack Contribute, Style Guide in the Contribute section of the OP Stack ecosystem. | ||
| lang: en-US | ||
| --- | ||
|
|
||
| import { Card, Cards } from 'nextra/components' | ||
|
|
||
| # Contribute | ||
|
|
||
| This section provides information on ways to contribute to optimism docs, contribute to the op stack and optimism docs style guide. You'll find tutorial, overview, guide to help you understand and work with these topics. | ||
| Documentation covering Docs Contribute, Stack Contribute, Style Guide in the Contribute section of the OP Stack ecosystem. | ||
krofax marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Cards> | ||
| <Card title="Ways to contribute to optimism docs" href="/connect/contribute/docs-contribute" /> | ||
|
|
||
| <Card title="Contribute to the op stack" href="/connect/contribute/stack-contribute" /> | ||
|
|
||
| <Card title="Optimism docs style guide" href="/connect/contribute/style-guide" /> | ||
| <Card title="Ways to contribute to Optimism Docs" href="/connect/contribute/docs-contribute" /> | ||
| <Card title="Contribute to the OP Stack" href="/connect/contribute/stack-contribute" /> | ||
| <Card title="Optimism Docs style guide" href="/connect/contribute/style-guide" /> | ||
| </Cards> | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.