fix conflict

ethereum-optimism · Nov 7, 2024 · 3a0a9bb · 3a0a9bb
2 parents 36fea13 + 442f4c6
commit 3a0a9bb
Show file tree

Hide file tree

Showing 162 changed files with 4,467 additions and 2,437 deletions.
diff --git a/.coderabbit.yaml b/.coderabbit.yaml
@@ -14,10 +14,14 @@ reviews:
         - Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
         - Ensure proper nouns are capitalized in sentences.
         - Apply the Oxford comma.
-        - Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
+        - Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
         - Use correct spelling and grammar at all times (IMPORTANT).
-        - Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
-        - For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
+        - For H1, H2, and H3 headers:
+          1. Use sentence case, capitalizing only the first word.
+          2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
+          3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
+        - Flag any headers that seem to inconsistently apply these rules for manual review.
+        - When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
         "
   auto_review:
     enabled: true

diff --git a/.github/ISSUE_TEMPLATE/docs_audit_results.md b/.github/ISSUE_TEMPLATE/docs_audit_results.md
@@ -9,7 +9,25 @@ labels: 'docs-audit-2024-Q4,op-labs'
 
 ## Description of the updates required
 
-> Write a description of the current state of the page.
+<!-- Write a description of the current state of the page. -->
+
+### Acceptance criteria
+
+<!-- Definition of done for the assignee -->
+
+### Resources
+
+<!-- Supporting docs, points of contact, and any additional helpful info -->
+
+### Action items
+
+<!-- The process for working through this issue for example:
+1. Read through resources and meet with SME
+2. Write the first draft
+3. Share draft with SMEs and implement feedback
+4. Peer review
+5. Final SME review
+6. Publish -->
 
 ## Github issue label criteria
 

diff --git a/.github/workflows/breadcrumbs.yml b/.github/workflows/breadcrumbs.yml
@@ -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
diff --git a/.github/workflows/monthly-issue-metircs.yml b/.github/workflows/monthly-issue-metircs.yml
@@ -41,6 +41,8 @@ jobs:
         token: ${{ secrets.GITHUB_TOKEN }}
         content-filepath: ./issue_metrics.md
         assignees: sbvegan
+        labels: |
+          monthly-report
 
     - name: Run issue-metrics tool for issues last month
       uses: github/issue-metrics@v2

diff --git a/.github/workflows/tutorials.yml b/.github/workflows/tutorials.yml
@@ -10,7 +10,7 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  cross-dom-bridge-erc20:
+  cross-dom-bridge-eth:
     runs-on: ubuntu-latest
 
     steps:
@@ -32,7 +32,7 @@ jobs:
       env:
         TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }}
       run:
-        node ./public/tutorials/cross-dom-bridge-erc20.js
+        node ./public/tutorials/cross-dom-bridge-eth.js
 
     - name: Notify Slack on failure
       uses: ravsamhq/notify-slack-action@v2
@@ -47,8 +47,8 @@ jobs:
       env:
         SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
-  cross-dom-bridge-eth:
-    needs: cross-dom-bridge-erc20
+  send-tx-from-eth:
+    needs: cross-dom-bridge-eth
     runs-on: ubuntu-latest
 
     steps:
@@ -70,7 +70,7 @@ jobs:
       env:
         TUTORIAL_PRIVATE_KEY: ${{ secrets.TUTORIAL_PRIVATE_KEY }}
       run:
-        node ./public/tutorials/cross-dom-bridge-eth.js
+        node ./public/tutorials/send-tx-from-eth.js
 
     - name: Notify Slack on failure
       uses: ravsamhq/notify-slack-action@v2
@@ -86,7 +86,7 @@ jobs:
         SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
   sdk-estimate-costs:
-    needs: cross-dom-bridge-eth
+    needs: send-tx-from-eth
     runs-on: ubuntu-latest
 
     steps:

diff --git a/components/calculator/ResultsTable.tsx b/components/calculator/ResultsTable.tsx
@@ -108,13 +108,11 @@ export function ResultsTable({
           <p className="calculator-info calculator-text">
             <strong>Note: </strong>This is an estimation,{" "}
             <a
-              href="https://docs.optimism.io/builders/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
+              href="/builders/chain-operators/management/blobs#determine-scalar-values-for-using-blobs"
               target="_blank"
             >
-              see the Optimism Docs
-            </a>{" "}
-            for steps on modifying parameters if needed once the chain is on
-            mainnet{" "}
+              read how to determine scalar values using blobs
+            </a>
           </p>
         </div>
         <div className="results-table-wrap">

diff --git a/lychee.toml b/lychee.toml
@@ -36,7 +36,8 @@ exclude = [
     'https://archive.org',
     'https://web.archive.org',
     'https://mainnet.base.org',
-    'https://sepolia.base.org'
+    'https://sepolia.base.org',
+    'https://optimism.easscan.org'
 ]
 
 # Accept these status codes

diff --git a/notes/breadcrumbs.md b/notes/breadcrumbs.md
@@ -0,0 +1,42 @@
+# 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 breadcrumbs
+```
+
+*   To check files with missing breadcrumbs, run:
+
+```bash
+pnpm fix
+```
+
+### 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, please update the description.
+   *   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
diff --git a/nouns.txt b/nouns.txt
@@ -0,0 +1,20 @@
+Optimism
+OP Mainnet
+Ethereum
+OP Stack
+MetaMask
+SuperchainERC20
+ZK
+Security Council
+Sequencer PBS
+Superchain Registry
+Retro Funding
+Alt-DA
+Teleportr
+Dev Console
+Granite
+Holocene
+Monitorism
+Kubernetes
+Fault Proof System
+Viem
diff --git a/package.json b/package.json
@@ -3,11 +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\"",
+    "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",
@@ -28,7 +30,8 @@
     "nextra-theme-docs": "2.13.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "search-insights": "^2.15.0"
+    "search-insights": "^2.15.0",
+    "viem": "^2.21.18"
   },
   "devDependencies": {
     "@double-great/remark-lint-alt-text": "^1.0.0",

diff --git a/pages/_meta.json b/pages/_meta.json
@@ -1,6 +1,6 @@
 {
   "index": {
-    "title": "Getting Started",
+    "title": "Getting started",
     "display": "hidden",
     "theme": {
       "breadcrumb": false,
@@ -38,13 +38,13 @@
   },
 
   "faucet": {
-    "title": "Superchain Faucet",
+    "title": "Superchain faucet",
     "type": "page",
     "href": "https://console.optimism.io/faucet?utm_source=docs",
     "newWindow": true
   },
   "gas": {
-    "title": "Gas Tracker",
+    "title": "Gas tracker",
     "type": "page",
     "href": "https://optimistic.grafana.net/public-dashboards/c84a5a9924fe4e14b270a42a8651ceb8?orgId=1&refresh=5m",
     "newWindow": true

diff --git a/pages/builders.mdx b/pages/builders.mdx
@@ -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>
diff --git a/pages/builders/_meta.json b/pages/builders/_meta.json
@@ -1,8 +1,8 @@
 {
   "notices": "Notices (README)",
-  "app-developers": "App Developers",
-  "chain-operators": "Chain Operators",
-  "node-operators": "Node Operators",
+  "app-developers": "App developers",
+  "chain-operators": "Chain operators",
+  "node-operators": "Node operators",
   "cex-wallet-developers": "Wallets & CEXs",
-  "tools": "Developer Tools"
+  "tools": "Developer tools"
 }
diff --git a/pages/builders/app-developers.mdx b/pages/builders/app-developers.mdx
@@ -0,0 +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
+---
+
+import { Card, Cards } from 'nextra/components'
+
+# App Developers
+
+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="Bridging" href="/builders/app-developers/bridging" />
+
+  <Card title="Contracts" href="/builders/app-developers/contracts" />
+
+  <Card title="App developer overview" href="/builders/app-developers/overview" />
+
+  <Card title="Superchain app quick start" href="/builders/app-developers/quick-start" />
+
+  <Card title="Tools" href="/builders/app-developers/tools" />
+
+  <Card title="Transactions" href="/builders/app-developers/transactions" />
+
+  <Card title="Tutorials" href="/builders/app-developers/tutorials" />
+</Cards>
diff --git a/pages/builders/app-developers/_meta.json b/pages/builders/app-developers/_meta.json
@@ -1,9 +1,9 @@
 {
     "overview": "Overview",
-    "quick-start": "Superchain App Quick Start",
+    "quick-start": "Superchain app quick start",
     "tutorials": "Tutorials",
-    "contracts": "Smart Contracts",
+    "contracts": "Smart contracts",
     "transactions": "Transactions",
     "bridging": "Bridging",
-    "tools": "App Tools"
+    "tools": "App tools"
 }
diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx
@@ -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>
diff --git a/pages/builders/app-developers/bridging/_meta.json b/pages/builders/app-developers/bridging/_meta.json
@@ -1,6 +1,6 @@
 {
-    "basics": "Basics of Bridging",
+    "basics": "Basics of bridging",
     "standard-bridge": "The Standard Bridge",
-    "custom-bridge": "Custom Token Bridges",
-    "messaging": "Sending Data Between L1 and L2"
+    "custom-bridge": "Custom token bridges",
+    "messaging": "Sending data between L1 and L2"
 }