Skip to content

Commit

Permalink
Merge pull request #1060 from ethereum-optimism/automation
Browse files Browse the repository at this point in the history
Updated Breadcrumb script
  • Loading branch information
krofax authored Nov 4, 2024
2 parents ac09bb1 + be06f2d commit cddbdac
Show file tree
Hide file tree
Showing 28 changed files with 637 additions and 118 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/breadcrumbs.yml
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
12 changes: 9 additions & 3 deletions notes/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@ Quick guide on using our breadcrumbs automation script for the OP Stack document

## Using the Script

Breadcrumbs for the docs can be generated by running:
* Breadcrumbs for the docs can be generated by running:

```bash
pnpm create-breadcrumbs
pnpm breadcrumbs
```

* To check files with missing breadcrumbs, run:

```bash
pnpm fix
```

### What to Watch For
Expand All @@ -26,7 +32,7 @@ pnpm create-breadcrumbs

2. **After Running**
* Review generated `.mdx` files in each folder
* Check updated descriptions
* Check updated descriptions, please update the description.
* Verify Card components and links

## Common Issues
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
"version": "0.0.1",
"description": "Optimism Docs",
"scripts": {
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint",
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix",
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs",
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm check-breadcrumbs",
"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",
"breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumbs.ts",
"check-breadcrumbs":"npx ts-node --skip-project utils/breadcrumbs.ts",
"index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",
"dev": "next dev",
"build": "next build",
Expand Down
19 changes: 9 additions & 10 deletions pages/builders/app-developers.mdx
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 ...

<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>
2 changes: 2 additions & 0 deletions pages/builders/app-developers/contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ This section provides information on Solidity compatibility, contract optimizati
<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" />

<Card title="Superchain-erc20" href="/builders/app-developers/contracts/superchain-erc20" />
</Cards>
14 changes: 6 additions & 8 deletions pages/builders/cex-wallet-developers.mdx
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.
lang: en-US
---

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

# CEX Wallet Developers
# 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.
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>
10 changes: 5 additions & 5 deletions pages/builders/chain-operators.mdx
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
title: Chain Operators
description: Documentation covering Architecture, Configuration, Deploy, Features, Hacks, Management, Self Hosted, Tools, Tutorials in the Chain Operators section of the OP Stack ecosystem.
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
# 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.
Documentation covering Architecture, Configuration, Deploy, Features, Hacks, Management, Self Hosted, Tools, Tutorials in the Chain Operators section of the OP Stack ecosystem.

<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="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="How to start a self-hosted chain" href="/builders/chain-operators/self-hosted" />

<Card title="Tools" href="/builders/chain-operators/tools" />

Expand Down
4 changes: 4 additions & 0 deletions pages/builders/chain-operators/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,9 @@ This section provides information on chain monitoring options, deploying a block

<Card title="Conductor" href="/builders/chain-operators/tools/op-conductor" />

<Card title="OP txproxyd" href="/builders/chain-operators/tools/op-txproxy" />

<Card title="Proxyd" href="/builders/chain-operators/tools/proxyd" />

<Card title="Deployer" href="/builders/chain-operators/tools/op-deployer" />
</Cards>
10 changes: 5 additions & 5 deletions pages/builders/node-operators.mdx
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.
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.

<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>
6 changes: 3 additions & 3 deletions pages/builders/notices.mdx
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.
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.

<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>
6 changes: 3 additions & 3 deletions pages/builders/tools.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Tools
description: This section provides information on build, connect, fjord fee parameter calculator, monitor, op tools and developer tools. You'll find guide, tool,...
description: Welcome to the Optimism developer tools!
lang: en-US
---

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

# Tools

This section provides information on build, connect, fjord fee parameter calculator, monitor, op tools and developer tools. You'll find guide, tool, overview to help you understand and work with these topics.
Welcome to the Optimism developer tools!

<Cards>
<Card title="Build" href="/builders/tools/build" />
Expand All @@ -19,7 +19,7 @@ This section provides information on build, connect, fjord fee parameter calcula

<Card title="Monitor" href="/builders/tools/monitor" />

<Card title="Op tools" href="/builders/tools/op-tools" />
<Card title="Op Tools" href="/builders/tools/op-tools" />

<Card title="Developer tools" href="/builders/tools/overview" />
</Cards>
8 changes: 4 additions & 4 deletions pages/chain/identity.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: Identity
description: This section provides information on about attestations, attestation apps, contracts (eas), individual identity, organizations, identity overview,...
description: This guide explains the role of decentralized identity in the Optimism Collective and its key components.
lang: en-US
---

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

# Identity

This section provides information on about attestations, attestation apps, contracts (eas), individual identity, organizations, identity overview, projects and schemas. You'll find guide, reference, overview to help you understand and work with these topics.
This guide explains the role of decentralized identity in the Optimism Collective and its key components.

<Cards>
<Card title="About attestations" href="/chain/identity/about-attestations" />

<Card title="Attestation apps" href="/chain/identity/applications" />
<Card title="Attestation Apps" href="/chain/identity/applications" />

<Card title="Contracts (eas)" href="/chain/identity/contracts-eas" />
<Card title="Contracts (EAS)" href="/chain/identity/contracts-eas" />

<Card title="Individual identity" href="/chain/identity/individuals" />

Expand Down
10 changes: 4 additions & 6 deletions pages/chain/security.mdx
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.
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.

<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>
8 changes: 3 additions & 5 deletions pages/chain/testing.mdx
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.
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.

<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>
12 changes: 5 additions & 7 deletions pages/connect/contribute.mdx
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.

<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>
4 changes: 2 additions & 2 deletions pages/connect/resources.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Resources
description: This section provides information on . You'll find concept to help you understand and work with these topics.
description: Documentation covering Glossary in the Resources section of the OP Stack ecosystem.
lang: en-US
---

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

# Resources

This section provides information on . You'll find concept to help you understand and work with these topics.
Documentation covering Glossary in the Resources section of the OP Stack ecosystem.

<Cards>
<Card title="Glossary" href="/connect/resources/glossary" />
Expand Down
Loading

0 comments on commit cddbdac

Please sign in to comment.