From 7980202ae1135fa5bfee211e4cb114184b32297c Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 10:41:39 +0100 Subject: [PATCH 01/19] fix breadcrumb --- pages/builders.mdx | 20 ++++++++++++++++++ pages/builders/app-developers.mdx | 19 +++++++++++++++++ pages/builders/app-developers/bridging.mdx | 21 +++++++++++++++++++ .../app-developers/bridging/custom-bridge.mdx | 4 ++-- pages/builders/cex-wallet-developers.mdx | 17 +++++++++++++++ pages/builders/notices.mdx | 19 +++++++++++++++++ 6 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 pages/builders.mdx create mode 100644 pages/builders/app-developers.mdx create mode 100644 pages/builders/app-developers/bridging.mdx create mode 100644 pages/builders/cex-wallet-developers.mdx create mode 100644 pages/builders/notices.mdx diff --git a/pages/builders.mdx b/pages/builders.mdx new file mode 100644 index 000000000..320370a98 --- /dev/null +++ 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 + +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. + + + + + + + + + diff --git a/pages/builders/app-developers.mdx b/pages/builders/app-developers.mdx new file mode 100644 index 000000000..386659d03 --- /dev/null +++ b/pages/builders/app-developers.mdx @@ -0,0 +1,19 @@ +--- +title: App Developers +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' + +# App Developers + +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. + + + + + + + + diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx new file mode 100644 index 000000000..7aa4b0af9 --- /dev/null +++ b/pages/builders/app-developers/bridging.mdx @@ -0,0 +1,21 @@ +--- +title: Bridging +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' + +# Bridging + +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. + + + + + + + + + + diff --git a/pages/builders/app-developers/bridging/custom-bridge.mdx b/pages/builders/app-developers/bridging/custom-bridge.mdx index 23ea17319..d686bae85 100644 --- a/pages/builders/app-developers/bridging/custom-bridge.mdx +++ b/pages/builders/app-developers/bridging/custom-bridge.mdx @@ -15,7 +15,7 @@ This guide provides important information you should be aware of when building a 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. ## Guidelines @@ -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 diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx new file mode 100644 index 000000000..7c10a3564 --- /dev/null +++ b/pages/builders/cex-wallet-developers.mdx @@ -0,0 +1,17 @@ +--- +title: CEX Wallet For Developers +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' + +# CEX Wallet For Developers + +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. + + + + + + diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx new file mode 100644 index 000000000..a813d3f8b --- /dev/null +++ b/pages/builders/notices.mdx @@ -0,0 +1,19 @@ +--- +title: Notices +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' + +# Notices + +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. + + + + + + + + From 1169966829e65e99a1b3eb5285ca21ae01663a5c Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 11:41:17 +0100 Subject: [PATCH 02/19] Create an automation script --- package.json | 1 + pages/builders/app-developers.mdx | 16 ++++--- pages/builders/notices.mdx | 2 +- utils/create-breadcrumbs.ts | 80 +++++++++++++++++++++++++++++++ 4 files changed, 91 insertions(+), 8 deletions(-) create mode 100644 utils/create-breadcrumbs.ts diff --git a/package.json b/package.json index 7d4036e50..e2cb1242d 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,7 @@ "linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"", "index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts", "dev": "next dev", + "create-breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumb.ts", "build": "next build", "start": "next start", "postbuild": "next-sitemap" diff --git a/pages/builders/app-developers.mdx b/pages/builders/app-developers.mdx index 386659d03..671d45bf2 100644 --- a/pages/builders/app-developers.mdx +++ b/pages/builders/app-developers.mdx @@ -1,19 +1,21 @@ --- title: App Developers 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' # App Developers -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. +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 - - - - + + - + + + + + \ No newline at end of file diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index a813d3f8b..7d0f5b5c8 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -8,7 +8,7 @@ import { Card, Cards } from 'nextra/components' # Notices -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. +Stay informed on important updates and announcements regarding the latest changes, improvements, and deprecations in OP Stack with our Notices page. diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts new file mode 100644 index 000000000..0a4adb47a --- /dev/null +++ b/utils/create-breadcrumbs.ts @@ -0,0 +1,80 @@ +import * as fs from 'fs/promises'; +import * as path from 'path'; + +const targetFolders: string[] = ['builders', 'chain', 'stack', 'connect']; +const rootDir: string = path.join(__dirname, '..', 'pages'); + +interface FileInfo { + title: string; + url: string; +} + +const createIndexFile = async (folderPath: string, folderName: string): Promise => { + const files = await fs.readdir(folderPath); + const mdFiles = files.filter(file => file.endsWith('.md') && file !== 'index.md'); + + const title = folderName.charAt(0).toUpperCase() + folderName.slice(1); + + let content = `--- +title: ${title} +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# ${title} + +Welcome to the ${title} section. Here you'll find resources and information related to ${folderName}. + + +`; + + const filePromises: Promise[] = mdFiles.map(async (file) => { + const filePath = path.join(folderPath, file); + const fileContent = await fs.readFile(filePath, 'utf-8'); + const fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, '.md'); + const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, '.md')}`.replace(/\\/g, '/'); + + return { title: fileTitle, url: relativeUrl }; + }); + + const fileInfos = await Promise.all(filePromises); + + fileInfos.forEach(({ title, url }) => { + content += ` \n`; + }); + + content += ''; + + await fs.writeFile(path.join(folderPath, 'index.md'), content); + console.log(`Created index.md in ${folderPath}`); +}; + +const processFolder = async (folderPath: string): Promise => { + try { + const files = await fs.readdir(folderPath); + + for (const file of files) { + const filePath = path.join(folderPath, file); + const stats = await fs.stat(filePath); + + if (stats.isDirectory()) { + await createIndexFile(filePath, file); + await processFolder(filePath); + } + } + } catch (error) { + console.error(`Error processing folder ${folderPath}:`, error); + } +}; + +const main = async (): Promise => { + for (const folder of targetFolders) { + const folderPath = path.join(rootDir, folder); + await processFolder(folderPath); + } +}; + +main().catch(console.error); + +console.log('Root directory:', rootDir); \ No newline at end of file From fbc2ca8863d54eb3424e7e4a0cc5b8b476c72a39 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 11:59:39 +0100 Subject: [PATCH 03/19] updated scripts --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index e2cb1242d..7d4036e50 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,6 @@ "linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"", "index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts", "dev": "next dev", - "create-breadcrumbs":"npx ts-node --skip-project utils/create-breadcrumb.ts", "build": "next build", "start": "next start", "postbuild": "next-sitemap" From f7411ae40095fea2094471210f73df666bc2b360 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 11:59:50 +0100 Subject: [PATCH 04/19] update script commad --- package.json | 1 + utils/create-breadcrumbs.ts | 14 ++++++++------ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 7d4036e50..856bae818 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index 0a4adb47a..50159fc91 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -9,9 +9,9 @@ interface FileInfo { url: string; } -const createIndexFile = async (folderPath: string, folderName: string): Promise => { +const createMdxFile = async (folderPath: string, folderName: string): Promise => { const files = await fs.readdir(folderPath); - const mdFiles = files.filter(file => file.endsWith('.md') && file !== 'index.md'); + const mdFiles = files.filter(file => file.endsWith('.md') || file.endsWith('.mdx')); const title = folderName.charAt(0).toUpperCase() + folderName.slice(1); @@ -33,7 +33,7 @@ Welcome to the ${title} section. Here you'll find resources and information rela const filePath = path.join(folderPath, file); const fileContent = await fs.readFile(filePath, 'utf-8'); const fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, '.md'); - const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, '.md')}`.replace(/\\/g, '/'); + const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); return { title: fileTitle, url: relativeUrl }; }); @@ -46,8 +46,9 @@ Welcome to the ${title} section. Here you'll find resources and information rela content += ''; - await fs.writeFile(path.join(folderPath, 'index.md'), content); - console.log(`Created index.md in ${folderPath}`); + const mdxFileName = `${folderName}.mdx`; + await fs.writeFile(path.join(folderPath, mdxFileName), content); + console.log(`Created ${mdxFileName} in ${folderPath}`); }; const processFolder = async (folderPath: string): Promise => { @@ -59,7 +60,7 @@ const processFolder = async (folderPath: string): Promise => { const stats = await fs.stat(filePath); if (stats.isDirectory()) { - await createIndexFile(filePath, file); + await createMdxFile(filePath, file); await processFolder(filePath); } } @@ -77,4 +78,5 @@ const main = async (): Promise => { main().catch(console.error); +// Log the root directory for debugging console.log('Root directory:', rootDir); \ No newline at end of file From 0bead81fe9d768f186d0254c6a4c4b126ab9a013 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 12:21:57 +0100 Subject: [PATCH 05/19] create breadcrumbs --- pages/builders/app-developers/bridging.mdx | 14 +++---- pages/builders/app-developers/contracts.mdx | 16 ++++++++ pages/builders/app-developers/tools.mdx | 15 +++++++ .../builders/app-developers/transactions.mdx | 18 ++++++++ pages/builders/app-developers/tutorials.mdx | 23 +++++++++++ pages/builders/cex-wallet-developers.mdx | 14 +++---- pages/builders/chain-operators.mdx | 15 +++++++ .../chain-operators/configuration.mdx | 17 ++++++++ pages/builders/chain-operators/deploy.mdx | 16 ++++++++ pages/builders/chain-operators/features.mdx | 18 ++++++++ pages/builders/chain-operators/hacks.mdx | 19 +++++++++ pages/builders/chain-operators/management.mdx | 19 +++++++++ pages/builders/chain-operators/tools.mdx | 18 ++++++++ pages/builders/chain-operators/tutorials.mdx | 19 +++++++++ pages/builders/node-operators.mdx | 18 ++++++++ .../builders/node-operators/configuration.mdx | 16 ++++++++ pages/builders/node-operators/management.mdx | 18 ++++++++ pages/builders/node-operators/tutorials.mdx | 17 ++++++++ pages/builders/notices.mdx | 11 ++--- pages/builders/tools.mdx | 15 +++++++ pages/builders/tools/build.mdx | 18 ++++++++ pages/builders/tools/connect.mdx | 15 +++++++ pages/builders/tools/monitor.mdx | 15 +++++++ pages/builders/tools/op-tools.mdx | 13 ++++++ pages/chain/identity.mdx | 21 ++++++++++ pages/chain/security.mdx | 16 ++++++++ pages/chain/testing.mdx | 15 +++++++ pages/connect/contribute.mdx | 16 ++++++++ pages/connect/resources.mdx | 14 +++++++ pages/stack/operators.mdx | 13 ++++++ pages/stack/operators/features.mdx | 15 +++++++ pages/stack/protocol.mdx | 15 +++++++ pages/stack/protocol/fault-proofs.mdx | 19 +++++++++ pages/stack/protocol/features.mdx | 16 ++++++++ pages/stack/protocol/interop.mdx | 16 ++++++++ pages/stack/protocol/rollup.mdx | 18 ++++++++ pages/stack/security.mdx | 15 +++++++ pages/stack/transactions.mdx | 14 +++++++ utils/create-breadcrumbs.ts | 41 ++++++++++++++----- 39 files changed, 626 insertions(+), 35 deletions(-) create mode 100644 pages/builders/app-developers/contracts.mdx create mode 100644 pages/builders/app-developers/tools.mdx create mode 100644 pages/builders/app-developers/transactions.mdx create mode 100644 pages/builders/app-developers/tutorials.mdx create mode 100644 pages/builders/chain-operators.mdx create mode 100644 pages/builders/chain-operators/configuration.mdx create mode 100644 pages/builders/chain-operators/deploy.mdx create mode 100644 pages/builders/chain-operators/features.mdx create mode 100644 pages/builders/chain-operators/hacks.mdx create mode 100644 pages/builders/chain-operators/management.mdx create mode 100644 pages/builders/chain-operators/tools.mdx create mode 100644 pages/builders/chain-operators/tutorials.mdx create mode 100644 pages/builders/node-operators.mdx create mode 100644 pages/builders/node-operators/configuration.mdx create mode 100644 pages/builders/node-operators/management.mdx create mode 100644 pages/builders/node-operators/tutorials.mdx create mode 100644 pages/builders/tools.mdx create mode 100644 pages/builders/tools/build.mdx create mode 100644 pages/builders/tools/connect.mdx create mode 100644 pages/builders/tools/monitor.mdx create mode 100644 pages/builders/tools/op-tools.mdx create mode 100644 pages/chain/identity.mdx create mode 100644 pages/chain/security.mdx create mode 100644 pages/chain/testing.mdx create mode 100644 pages/connect/contribute.mdx create mode 100644 pages/connect/resources.mdx create mode 100644 pages/stack/operators.mdx create mode 100644 pages/stack/operators/features.mdx create mode 100644 pages/stack/protocol.mdx create mode 100644 pages/stack/protocol/fault-proofs.mdx create mode 100644 pages/stack/protocol/features.mdx create mode 100644 pages/stack/protocol/interop.mdx create mode 100644 pages/stack/protocol/rollup.mdx create mode 100644 pages/stack/security.mdx create mode 100644 pages/stack/transactions.mdx diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx index 7aa4b0af9..96a048e64 100644 --- a/pages/builders/app-developers/bridging.mdx +++ b/pages/builders/app-developers/bridging.mdx @@ -1,21 +1,17 @@ --- title: Bridging 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' # Bridging -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. +Welcome to the Bridging section. Here you'll find resources and information related to bridging. - - - - - - + + - + + \ No newline at end of file diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx new file mode 100644 index 000000000..faff74bf3 --- /dev/null +++ b/pages/builders/app-developers/contracts.mdx @@ -0,0 +1,16 @@ +--- +title: Contracts +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Contracts + +Welcome to the Contracts section. Here you'll find resources and information related to contracts. + + + + + + \ No newline at end of file diff --git a/pages/builders/app-developers/tools.mdx b/pages/builders/app-developers/tools.mdx new file mode 100644 index 000000000..4a7f25d80 --- /dev/null +++ b/pages/builders/app-developers/tools.mdx @@ -0,0 +1,15 @@ +--- +title: Tools +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tools + +Welcome to the Tools section. Here you'll find resources and information related to tools. + + + + + \ No newline at end of file diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx new file mode 100644 index 000000000..6e7549ea0 --- /dev/null +++ b/pages/builders/app-developers/transactions.mdx @@ -0,0 +1,18 @@ +--- +title: Transactions +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Transactions + +Welcome to the Transactions section. Here you'll find resources and information related to transactions. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx new file mode 100644 index 000000000..011f2c5fb --- /dev/null +++ b/pages/builders/app-developers/tutorials.mdx @@ -0,0 +1,23 @@ +--- +title: Tutorials +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tutorials + +Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. + + + + + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 7c10a3564..25de150e6 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -1,17 +1,15 @@ --- -title: CEX Wallet For Developers +title: Cex-wallet-developers 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' -# CEX Wallet For Developers +# Cex-wallet-developers -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. +Welcome to the Cex-wallet-developers section. Here you'll find resources and information related to cex-wallet-developers. - - - - + + + \ No newline at end of file diff --git a/pages/builders/chain-operators.mdx b/pages/builders/chain-operators.mdx new file mode 100644 index 000000000..172f83ea4 --- /dev/null +++ b/pages/builders/chain-operators.mdx @@ -0,0 +1,15 @@ +--- +title: Chain-operators +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Chain-operators + +Welcome to the Chain-operators section. Here you'll find resources and information related to chain-operators. + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/configuration.mdx b/pages/builders/chain-operators/configuration.mdx new file mode 100644 index 000000000..1d77a3cc0 --- /dev/null +++ b/pages/builders/chain-operators/configuration.mdx @@ -0,0 +1,17 @@ +--- +title: Configuration +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Configuration + +Welcome to the Configuration section. Here you'll find resources and information related to configuration. + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/deploy.mdx b/pages/builders/chain-operators/deploy.mdx new file mode 100644 index 000000000..e313903be --- /dev/null +++ b/pages/builders/chain-operators/deploy.mdx @@ -0,0 +1,16 @@ +--- +title: Deploy +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Deploy + +Welcome to the Deploy section. Here you'll find resources and information related to deploy. + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx new file mode 100644 index 000000000..07f0ac010 --- /dev/null +++ b/pages/builders/chain-operators/features.mdx @@ -0,0 +1,18 @@ +--- +title: Features +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Features + +Welcome to the Features section. Here you'll find resources and information related to features. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx new file mode 100644 index 000000000..3e01c445b --- /dev/null +++ b/pages/builders/chain-operators/hacks.mdx @@ -0,0 +1,19 @@ +--- +title: Hacks +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Hacks + +Welcome to the Hacks section. Here you'll find resources and information related to hacks. + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx new file mode 100644 index 000000000..65121bfc4 --- /dev/null +++ b/pages/builders/chain-operators/management.mdx @@ -0,0 +1,19 @@ +--- +title: Management +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Management + +Welcome to the Management section. Here you'll find resources and information related to management. + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx new file mode 100644 index 000000000..a1899bf1a --- /dev/null +++ b/pages/builders/chain-operators/tools.mdx @@ -0,0 +1,18 @@ +--- +title: Tools +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tools + +Welcome to the Tools section. Here you'll find resources and information related to tools. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx new file mode 100644 index 000000000..f993a94e9 --- /dev/null +++ b/pages/builders/chain-operators/tutorials.mdx @@ -0,0 +1,19 @@ +--- +title: Tutorials +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tutorials + +Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx new file mode 100644 index 000000000..56d3a9bbc --- /dev/null +++ b/pages/builders/node-operators.mdx @@ -0,0 +1,18 @@ +--- +title: Node-operators +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Node-operators + +Welcome to the Node-operators section. Here you'll find resources and information related to node-operators. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx new file mode 100644 index 000000000..f7cbbb167 --- /dev/null +++ b/pages/builders/node-operators/configuration.mdx @@ -0,0 +1,16 @@ +--- +title: Configuration +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Configuration + +Welcome to the Configuration section. Here you'll find resources and information related to configuration. + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx new file mode 100644 index 000000000..302c41771 --- /dev/null +++ b/pages/builders/node-operators/management.mdx @@ -0,0 +1,18 @@ +--- +title: Management +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Management + +Welcome to the Management section. Here you'll find resources and information related to management. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx new file mode 100644 index 000000000..1e8d23467 --- /dev/null +++ b/pages/builders/node-operators/tutorials.mdx @@ -0,0 +1,17 @@ +--- +title: Tutorials +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tutorials + +Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. + + + + + + + \ No newline at end of file diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index 7d0f5b5c8..eeddcb0a8 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -1,19 +1,16 @@ --- title: Notices 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' # Notices -Stay informed on important updates and announcements regarding the latest changes, improvements, and deprecations in OP Stack with our Notices page. +Welcome to the Notices section. Here you'll find resources and information related to notices. - - - - - + + + \ No newline at end of file diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx new file mode 100644 index 000000000..4e0d1a3bb --- /dev/null +++ b/pages/builders/tools.mdx @@ -0,0 +1,15 @@ +--- +title: Tools +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Tools + +Welcome to the Tools section. Here you'll find resources and information related to tools. + + + + + \ No newline at end of file diff --git a/pages/builders/tools/build.mdx b/pages/builders/tools/build.mdx new file mode 100644 index 000000000..d1c345204 --- /dev/null +++ b/pages/builders/tools/build.mdx @@ -0,0 +1,18 @@ +--- +title: Build +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Build + +Welcome to the Build section. Here you'll find resources and information related to build. + + + + + + + + \ No newline at end of file diff --git a/pages/builders/tools/connect.mdx b/pages/builders/tools/connect.mdx new file mode 100644 index 000000000..9401fe7e4 --- /dev/null +++ b/pages/builders/tools/connect.mdx @@ -0,0 +1,15 @@ +--- +title: Connect +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Connect + +Welcome to the Connect section. Here you'll find resources and information related to connect. + + + + + \ No newline at end of file diff --git a/pages/builders/tools/monitor.mdx b/pages/builders/tools/monitor.mdx new file mode 100644 index 000000000..4205bce36 --- /dev/null +++ b/pages/builders/tools/monitor.mdx @@ -0,0 +1,15 @@ +--- +title: Monitor +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Monitor + +Welcome to the Monitor section. Here you'll find resources and information related to monitor. + + + + + \ No newline at end of file diff --git a/pages/builders/tools/op-tools.mdx b/pages/builders/tools/op-tools.mdx new file mode 100644 index 000000000..56cd347b8 --- /dev/null +++ b/pages/builders/tools/op-tools.mdx @@ -0,0 +1,13 @@ +--- +title: Op-tools +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Op-tools + +Welcome to the Op-tools section. Here you'll find resources and information related to op-tools. + + + \ No newline at end of file diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx new file mode 100644 index 000000000..3e7c7cab5 --- /dev/null +++ b/pages/chain/identity.mdx @@ -0,0 +1,21 @@ +--- +title: Identity +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Identity + +Welcome to the Identity section. Here you'll find resources and information related to identity. + + + + + + + + + + + \ No newline at end of file diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx new file mode 100644 index 000000000..31e7523bc --- /dev/null +++ b/pages/chain/security.mdx @@ -0,0 +1,16 @@ +--- +title: Security +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Security + +Welcome to the Security section. Here you'll find resources and information related to security. + + + + + + \ No newline at end of file diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx new file mode 100644 index 000000000..1d55b3628 --- /dev/null +++ b/pages/chain/testing.mdx @@ -0,0 +1,15 @@ +--- +title: Testing +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Testing + +Welcome to the Testing section. Here you'll find resources and information related to testing. + + + + + \ No newline at end of file diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx new file mode 100644 index 000000000..689a1aa78 --- /dev/null +++ b/pages/connect/contribute.mdx @@ -0,0 +1,16 @@ +--- +title: Contribute +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Contribute + +Welcome to the Contribute section. Here you'll find resources and information related to contribute. + + + + + + \ No newline at end of file diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx new file mode 100644 index 000000000..11560af84 --- /dev/null +++ b/pages/connect/resources.mdx @@ -0,0 +1,14 @@ +--- +title: Resources +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Resources + +Welcome to the Resources section. Here you'll find resources and information related to resources. + + + + \ No newline at end of file diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx new file mode 100644 index 000000000..f95106122 --- /dev/null +++ b/pages/stack/operators.mdx @@ -0,0 +1,13 @@ +--- +title: Operators +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Operators + +Welcome to the Operators section. Here you'll find resources and information related to operators. + + + \ No newline at end of file diff --git a/pages/stack/operators/features.mdx b/pages/stack/operators/features.mdx new file mode 100644 index 000000000..36224f885 --- /dev/null +++ b/pages/stack/operators/features.mdx @@ -0,0 +1,15 @@ +--- +title: Features +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Features + +Welcome to the Features section. Here you'll find resources and information related to features. + + + + + \ No newline at end of file diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx new file mode 100644 index 000000000..5e337a120 --- /dev/null +++ b/pages/stack/protocol.mdx @@ -0,0 +1,15 @@ +--- +title: Protocol +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Protocol + +Welcome to the Protocol section. Here you'll find resources and information related to protocol. + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/fault-proofs.mdx b/pages/stack/protocol/fault-proofs.mdx new file mode 100644 index 000000000..8e728944e --- /dev/null +++ b/pages/stack/protocol/fault-proofs.mdx @@ -0,0 +1,19 @@ +--- +title: Fault-proofs +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Fault-proofs + +Welcome to the Fault-proofs section. Here you'll find resources and information related to fault-proofs. + + + + + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx new file mode 100644 index 000000000..f5be9ad0d --- /dev/null +++ b/pages/stack/protocol/features.mdx @@ -0,0 +1,16 @@ +--- +title: Features +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Features + +Welcome to the Features section. Here you'll find resources and information related to features. + + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx new file mode 100644 index 000000000..c292b0b31 --- /dev/null +++ b/pages/stack/protocol/interop.mdx @@ -0,0 +1,16 @@ +--- +title: Interop +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Interop + +Welcome to the Interop section. Here you'll find resources and information related to interop. + + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/rollup.mdx b/pages/stack/protocol/rollup.mdx new file mode 100644 index 000000000..af30d9de7 --- /dev/null +++ b/pages/stack/protocol/rollup.mdx @@ -0,0 +1,18 @@ +--- +title: Rollup +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Rollup + +Welcome to the Rollup section. Here you'll find resources and information related to rollup. + + + + + + + + \ No newline at end of file diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx new file mode 100644 index 000000000..bee8a8e32 --- /dev/null +++ b/pages/stack/security.mdx @@ -0,0 +1,15 @@ +--- +title: Security +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Security + +Welcome to the Security section. Here you'll find resources and information related to security. + + + + + \ No newline at end of file diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx new file mode 100644 index 000000000..c66f69362 --- /dev/null +++ b/pages/stack/transactions.mdx @@ -0,0 +1,14 @@ +--- +title: Transactions +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# Transactions + +Welcome to the Transactions section. Here you'll find resources and information related to transactions. + + + + \ No newline at end of file diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index 50159fc91..07d832721 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -9,9 +9,13 @@ interface FileInfo { url: string; } -const createMdxFile = async (folderPath: string, folderName: string): Promise => { +const createMdxFile = async (parentFolderPath: string, folderName: string): Promise => { + const folderPath = path.join(parentFolderPath, folderName); const files = await fs.readdir(folderPath); - const mdFiles = files.filter(file => file.endsWith('.md') || file.endsWith('.mdx')); + const mdFiles = files.filter(file => + (file.endsWith('.md') || file.endsWith('.mdx')) && + !file.startsWith('_') + ); const title = folderName.charAt(0).toUpperCase() + folderName.slice(1); @@ -29,16 +33,18 @@ Welcome to the ${title} section. Here you'll find resources and information rela `; - const filePromises: Promise[] = mdFiles.map(async (file) => { + const fileInfos: FileInfo[] = []; + + for (const file of mdFiles) { const filePath = path.join(folderPath, file); const fileContent = await fs.readFile(filePath, 'utf-8'); - const fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, '.md'); + const fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); - return { title: fileTitle, url: relativeUrl }; - }); - - const fileInfos = await Promise.all(filePromises); + if (!fileInfos.some(info => info.url === relativeUrl)) { + fileInfos.push({ title: fileTitle, url: relativeUrl }); + } + } fileInfos.forEach(({ title, url }) => { content += ` \n`; @@ -47,8 +53,21 @@ Welcome to the ${title} section. Here you'll find resources and information rela content += ''; const mdxFileName = `${folderName}.mdx`; - await fs.writeFile(path.join(folderPath, mdxFileName), content); - console.log(`Created ${mdxFileName} in ${folderPath}`); + const mdxFilePath = path.join(parentFolderPath, mdxFileName); + + // Check if the file already exists and has the same content + try { + const existingContent = await fs.readFile(mdxFilePath, 'utf-8'); + if (existingContent.trim() === content.trim()) { + console.log(`${mdxFileName} in ${parentFolderPath} is up to date. Skipping.`); + return; + } + } catch (error) { + // File doesn't exist, we'll create it + } + + await fs.writeFile(mdxFilePath, content); + console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`); }; const processFolder = async (folderPath: string): Promise => { @@ -60,7 +79,7 @@ const processFolder = async (folderPath: string): Promise => { const stats = await fs.stat(filePath); if (stats.isDirectory()) { - await createMdxFile(filePath, file); + await createMdxFile(folderPath, file); await processFolder(filePath); } } From 598285df9a70de6de15188f9de64db198536269c Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 12:25:19 +0100 Subject: [PATCH 06/19] update the breadcrumb result --- pages/builders/app-developers/bridging.mdx | 10 ++++----- pages/builders/app-developers/contracts.mdx | 8 +++---- pages/builders/app-developers/tools.mdx | 6 ++--- .../builders/app-developers/transactions.mdx | 12 +++++----- pages/builders/app-developers/tutorials.mdx | 22 +++++++++---------- pages/builders/cex-wallet-developers.mdx | 10 ++++----- pages/builders/chain-operators.mdx | 17 +++++++++----- .../chain-operators/configuration.mdx | 10 ++++----- pages/builders/chain-operators/deploy.mdx | 8 +++---- pages/builders/chain-operators/features.mdx | 12 +++++----- pages/builders/chain-operators/hacks.mdx | 14 ++++++------ pages/builders/chain-operators/management.mdx | 14 ++++++------ pages/builders/chain-operators/tools.mdx | 8 +++---- pages/builders/chain-operators/tutorials.mdx | 14 ++++++------ pages/builders/node-operators.mdx | 19 +++++++++------- .../builders/node-operators/configuration.mdx | 8 +++---- pages/builders/node-operators/management.mdx | 12 +++++----- pages/builders/node-operators/tutorials.mdx | 10 ++++----- pages/builders/notices.mdx | 8 +++---- pages/builders/tools.mdx | 10 ++++++--- pages/builders/tools/build.mdx | 10 ++++----- pages/builders/tools/connect.mdx | 6 ++--- pages/builders/tools/monitor.mdx | 6 ++--- pages/builders/tools/op-tools.mdx | 6 ++--- pages/chain/identity.mdx | 14 ++++++------ pages/chain/security.mdx | 8 +++---- pages/chain/testing.mdx | 6 ++--- pages/connect/contribute.mdx | 6 ++--- pages/connect/resources.mdx | 2 +- pages/stack/operators.mdx | 3 ++- pages/stack/operators/features.mdx | 6 ++--- pages/stack/protocol.mdx | 10 ++++++--- pages/stack/protocol/fault-proofs.mdx | 18 +++++++-------- pages/stack/protocol/features.mdx | 8 +++---- pages/stack/protocol/interop.mdx | 8 +++---- pages/stack/protocol/rollup.mdx | 12 +++++----- pages/stack/security.mdx | 6 ++--- pages/stack/transactions.mdx | 4 ++-- utils/create-breadcrumbs.ts | 13 ++++++++--- 39 files changed, 205 insertions(+), 179 deletions(-) diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx index 96a048e64..75004ef03 100644 --- a/pages/builders/app-developers/bridging.mdx +++ b/pages/builders/app-developers/bridging.mdx @@ -7,11 +7,11 @@ import { Card, Cards } from 'nextra/components' # Bridging -Welcome to the Bridging section. Here you'll find resources and information related to bridging. +Welcome to the Bridging section. Here you'll find resources and information related to Bridging. - - - - + + + + \ No newline at end of file diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index faff74bf3..4fc916ac7 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Contracts -Welcome to the Contracts section. Here you'll find resources and information related to contracts. +Welcome to the Contracts section. Here you'll find resources and information related to Contracts. - - - + + + \ No newline at end of file diff --git a/pages/builders/app-developers/tools.mdx b/pages/builders/app-developers/tools.mdx index 4a7f25d80..efc7fff02 100644 --- a/pages/builders/app-developers/tools.mdx +++ b/pages/builders/app-developers/tools.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to tools. +Welcome to the Tools section. Here you'll find resources and information related to Tools. - - + + \ No newline at end of file diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx index 6e7549ea0..ca3fbba82 100644 --- a/pages/builders/app-developers/transactions.mdx +++ b/pages/builders/app-developers/transactions.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Transactions -Welcome to the Transactions section. Here you'll find resources and information related to transactions. +Welcome to the Transactions section. Here you'll find resources and information related to Transactions. - - - - - + + + + + \ No newline at end of file diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx index 011f2c5fb..25d837e7a 100644 --- a/pages/builders/app-developers/tutorials.mdx +++ b/pages/builders/app-developers/tutorials.mdx @@ -7,17 +7,17 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. +Welcome to the Tutorials section. Here you'll find resources and information related to Tutorials. - - - - - - - - - - + + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 25de150e6..82d3e8b67 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -1,15 +1,15 @@ --- -title: Cex-wallet-developers +title: Cex Wallet Developers lang: en-US --- import { Card, Cards } from 'nextra/components' -# Cex-wallet-developers +# Cex Wallet Developers -Welcome to the Cex-wallet-developers section. Here you'll find resources and information related to cex-wallet-developers. +Welcome to the Cex Wallet Developers section. Here you'll find resources and information related to Cex Wallet Developers. - - + + \ No newline at end of file diff --git a/pages/builders/chain-operators.mdx b/pages/builders/chain-operators.mdx index 172f83ea4..813f1db8c 100644 --- a/pages/builders/chain-operators.mdx +++ b/pages/builders/chain-operators.mdx @@ -1,15 +1,22 @@ --- -title: Chain-operators +title: Chain Operators lang: en-US --- import { Card, Cards } from 'nextra/components' -# Chain-operators +# Chain Operators -Welcome to the Chain-operators section. Here you'll find resources and information related to chain-operators. +Welcome to the Chain Operators section. Here you'll find resources and information related to Chain Operators. - - + + + + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/configuration.mdx b/pages/builders/chain-operators/configuration.mdx index 1d77a3cc0..801a4e5c6 100644 --- a/pages/builders/chain-operators/configuration.mdx +++ b/pages/builders/chain-operators/configuration.mdx @@ -7,11 +7,11 @@ import { Card, Cards } from 'nextra/components' # Configuration -Welcome to the Configuration section. Here you'll find resources and information related to configuration. +Welcome to the Configuration section. Here you'll find resources and information related to Configuration. - - - - + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/deploy.mdx b/pages/builders/chain-operators/deploy.mdx index e313903be..15c11257e 100644 --- a/pages/builders/chain-operators/deploy.mdx +++ b/pages/builders/chain-operators/deploy.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Deploy -Welcome to the Deploy section. Here you'll find resources and information related to deploy. +Welcome to the Deploy section. Here you'll find resources and information related to Deploy. - - - + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx index 07f0ac010..399ae00af 100644 --- a/pages/builders/chain-operators/features.mdx +++ b/pages/builders/chain-operators/features.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to features. +Welcome to the Features section. Here you'll find resources and information related to Features. - - - - - + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx index 3e01c445b..2bcf974da 100644 --- a/pages/builders/chain-operators/hacks.mdx +++ b/pages/builders/chain-operators/hacks.mdx @@ -7,13 +7,13 @@ import { Card, Cards } from 'nextra/components' # Hacks -Welcome to the Hacks section. Here you'll find resources and information related to hacks. +Welcome to the Hacks section. Here you'll find resources and information related to Hacks. - - - - - - + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx index 65121bfc4..26d6dcc62 100644 --- a/pages/builders/chain-operators/management.mdx +++ b/pages/builders/chain-operators/management.mdx @@ -7,13 +7,13 @@ import { Card, Cards } from 'nextra/components' # Management -Welcome to the Management section. Here you'll find resources and information related to management. +Welcome to the Management section. Here you'll find resources and information related to Management. - - - - - - + + + + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx index a1899bf1a..a688a5900 100644 --- a/pages/builders/chain-operators/tools.mdx +++ b/pages/builders/chain-operators/tools.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to tools. +Welcome to the Tools section. Here you'll find resources and information related to Tools. - - - + + + \ No newline at end of file diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx index f993a94e9..716917fb4 100644 --- a/pages/builders/chain-operators/tutorials.mdx +++ b/pages/builders/chain-operators/tutorials.mdx @@ -7,13 +7,13 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. +Welcome to the Tutorials section. Here you'll find resources and information related to Tutorials. - - - - - - + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx index 56d3a9bbc..21f812bf2 100644 --- a/pages/builders/node-operators.mdx +++ b/pages/builders/node-operators.mdx @@ -1,18 +1,21 @@ --- -title: Node-operators +title: Node Operators lang: en-US --- import { Card, Cards } from 'nextra/components' -# Node-operators +# Node Operators -Welcome to the Node-operators section. Here you'll find resources and information related to node-operators. +Welcome to the Node Operators section. Here you'll find resources and information related to Node Operators. - - - - - + + + + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx index f7cbbb167..af4862bb8 100644 --- a/pages/builders/node-operators/configuration.mdx +++ b/pages/builders/node-operators/configuration.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Configuration -Welcome to the Configuration section. Here you'll find resources and information related to configuration. +Welcome to the Configuration section. Here you'll find resources and information related to Configuration. - - - + + + \ No newline at end of file diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx index 302c41771..5709df386 100644 --- a/pages/builders/node-operators/management.mdx +++ b/pages/builders/node-operators/management.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Management -Welcome to the Management section. Here you'll find resources and information related to management. +Welcome to the Management section. Here you'll find resources and information related to Management. - - - - - + + + + + \ No newline at end of file diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx index 1e8d23467..1d32f0985 100644 --- a/pages/builders/node-operators/tutorials.mdx +++ b/pages/builders/node-operators/tutorials.mdx @@ -7,11 +7,11 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to tutorials. +Welcome to the Tutorials section. Here you'll find resources and information related to Tutorials. - - - - + + + + \ No newline at end of file diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index eeddcb0a8..e78cb48b0 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Notices -Welcome to the Notices section. Here you'll find resources and information related to notices. +Welcome to the Notices section. Here you'll find resources and information related to Notices. - - - + + + \ No newline at end of file diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx index 4e0d1a3bb..6b85979c5 100644 --- a/pages/builders/tools.mdx +++ b/pages/builders/tools.mdx @@ -7,9 +7,13 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to tools. +Welcome to the Tools section. Here you'll find resources and information related to Tools. - - + + + + + + \ No newline at end of file diff --git a/pages/builders/tools/build.mdx b/pages/builders/tools/build.mdx index d1c345204..75cad2a37 100644 --- a/pages/builders/tools/build.mdx +++ b/pages/builders/tools/build.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Build -Welcome to the Build section. Here you'll find resources and information related to build. +Welcome to the Build section. Here you'll find resources and information related to Build. - - - - + + + + \ No newline at end of file diff --git a/pages/builders/tools/connect.mdx b/pages/builders/tools/connect.mdx index 9401fe7e4..d4d079032 100644 --- a/pages/builders/tools/connect.mdx +++ b/pages/builders/tools/connect.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Connect -Welcome to the Connect section. Here you'll find resources and information related to connect. +Welcome to the Connect section. Here you'll find resources and information related to Connect. - - + + \ No newline at end of file diff --git a/pages/builders/tools/monitor.mdx b/pages/builders/tools/monitor.mdx index 4205bce36..d7a559d9e 100644 --- a/pages/builders/tools/monitor.mdx +++ b/pages/builders/tools/monitor.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Monitor -Welcome to the Monitor section. Here you'll find resources and information related to monitor. +Welcome to the Monitor section. Here you'll find resources and information related to Monitor. - - + + \ No newline at end of file diff --git a/pages/builders/tools/op-tools.mdx b/pages/builders/tools/op-tools.mdx index 56cd347b8..9651722a5 100644 --- a/pages/builders/tools/op-tools.mdx +++ b/pages/builders/tools/op-tools.mdx @@ -1,13 +1,13 @@ --- -title: Op-tools +title: Op Tools lang: en-US --- import { Card, Cards } from 'nextra/components' -# Op-tools +# Op Tools -Welcome to the Op-tools section. Here you'll find resources and information related to op-tools. +Welcome to the Op Tools section. Here you'll find resources and information related to Op Tools. \ No newline at end of file diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index 3e7c7cab5..d527f33b9 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -7,15 +7,15 @@ import { Card, Cards } from 'nextra/components' # Identity -Welcome to the Identity section. Here you'll find resources and information related to identity. +Welcome to the Identity section. Here you'll find resources and information related to Identity. - - - - - + + + + + - + \ No newline at end of file diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index 31e7523bc..b792e5401 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Security -Welcome to the Security section. Here you'll find resources and information related to security. +Welcome to the Security section. Here you'll find resources and information related to Security. - - - + + + \ No newline at end of file diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index 1d55b3628..f71a3655b 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Testing -Welcome to the Testing section. Here you'll find resources and information related to testing. +Welcome to the Testing section. Here you'll find resources and information related to Testing. - - + + \ No newline at end of file diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index 689a1aa78..4572cb26c 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Contribute -Welcome to the Contribute section. Here you'll find resources and information related to contribute. +Welcome to the Contribute section. Here you'll find resources and information related to Contribute. - - + + \ No newline at end of file diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index 11560af84..afdf5a1e5 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Resources -Welcome to the Resources section. Here you'll find resources and information related to resources. +Welcome to the Resources section. Here you'll find resources and information related to Resources. diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx index f95106122..df960b5ed 100644 --- a/pages/stack/operators.mdx +++ b/pages/stack/operators.mdx @@ -7,7 +7,8 @@ import { Card, Cards } from 'nextra/components' # Operators -Welcome to the Operators section. Here you'll find resources and information related to operators. +Welcome to the Operators section. Here you'll find resources and information related to Operators. + \ No newline at end of file diff --git a/pages/stack/operators/features.mdx b/pages/stack/operators/features.mdx index 36224f885..d59bf04c4 100644 --- a/pages/stack/operators/features.mdx +++ b/pages/stack/operators/features.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to features. +Welcome to the Features section. Here you'll find resources and information related to Features. - - + + \ No newline at end of file diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx index 5e337a120..4644266af 100644 --- a/pages/stack/protocol.mdx +++ b/pages/stack/protocol.mdx @@ -7,9 +7,13 @@ import { Card, Cards } from 'nextra/components' # Protocol -Welcome to the Protocol section. Here you'll find resources and information related to protocol. +Welcome to the Protocol section. Here you'll find resources and information related to Protocol. - - + + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/fault-proofs.mdx b/pages/stack/protocol/fault-proofs.mdx index 8e728944e..4bd276ac1 100644 --- a/pages/stack/protocol/fault-proofs.mdx +++ b/pages/stack/protocol/fault-proofs.mdx @@ -1,19 +1,19 @@ --- -title: Fault-proofs +title: Fault Proofs lang: en-US --- import { Card, Cards } from 'nextra/components' -# Fault-proofs +# Fault Proofs -Welcome to the Fault-proofs section. Here you'll find resources and information related to fault-proofs. +Welcome to the Fault Proofs section. Here you'll find resources and information related to Fault Proofs. - - - - - - + + + + + + \ No newline at end of file diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx index f5be9ad0d..5c119c1c9 100644 --- a/pages/stack/protocol/features.mdx +++ b/pages/stack/protocol/features.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to features. +Welcome to the Features section. Here you'll find resources and information related to Features. - - - + + + \ No newline at end of file diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx index c292b0b31..d0e44d848 100644 --- a/pages/stack/protocol/interop.mdx +++ b/pages/stack/protocol/interop.mdx @@ -7,10 +7,10 @@ import { Card, Cards } from 'nextra/components' # Interop -Welcome to the Interop section. Here you'll find resources and information related to interop. +Welcome to the Interop section. Here you'll find resources and information related to Interop. - - - + + + \ No newline at end of file diff --git a/pages/stack/protocol/rollup.mdx b/pages/stack/protocol/rollup.mdx index af30d9de7..708a0cb74 100644 --- a/pages/stack/protocol/rollup.mdx +++ b/pages/stack/protocol/rollup.mdx @@ -7,12 +7,12 @@ import { Card, Cards } from 'nextra/components' # Rollup -Welcome to the Rollup section. Here you'll find resources and information related to rollup. +Welcome to the Rollup section. Here you'll find resources and information related to Rollup. - - - - - + + + + + \ No newline at end of file diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx index bee8a8e32..c591df29f 100644 --- a/pages/stack/security.mdx +++ b/pages/stack/security.mdx @@ -7,9 +7,9 @@ import { Card, Cards } from 'nextra/components' # Security -Welcome to the Security section. Here you'll find resources and information related to security. +Welcome to the Security section. Here you'll find resources and information related to Security. - - + + \ No newline at end of file diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx index c66f69362..da08d899f 100644 --- a/pages/stack/transactions.mdx +++ b/pages/stack/transactions.mdx @@ -7,8 +7,8 @@ import { Card, Cards } from 'nextra/components' # Transactions -Welcome to the Transactions section. Here you'll find resources and information related to transactions. +Welcome to the Transactions section. Here you'll find resources and information related to Transactions. - + \ No newline at end of file diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index 07d832721..ca3c896d9 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -9,6 +9,12 @@ interface FileInfo { url: string; } +function toTitleCase(str: string): string { + return str.split('-').map(word => + word.charAt(0).toUpperCase() + word.slice(1).toLowerCase() + ).join(' '); +} + const createMdxFile = async (parentFolderPath: string, folderName: string): Promise => { const folderPath = path.join(parentFolderPath, folderName); const files = await fs.readdir(folderPath); @@ -17,7 +23,7 @@ const createMdxFile = async (parentFolderPath: string, folderName: string): Prom !file.startsWith('_') ); - const title = folderName.charAt(0).toUpperCase() + folderName.slice(1); + const title = toTitleCase(folderName); let content = `--- title: ${title} @@ -28,7 +34,7 @@ import { Card, Cards } from 'nextra/components' # ${title} -Welcome to the ${title} section. Here you'll find resources and information related to ${folderName}. +Welcome to the ${title} section. Here you'll find resources and information related to ${title}. `; @@ -38,7 +44,8 @@ Welcome to the ${title} section. Here you'll find resources and information rela for (const file of mdFiles) { const filePath = path.join(folderPath, file); const fileContent = await fs.readFile(filePath, 'utf-8'); - const fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); + let fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); + fileTitle = toTitleCase(fileTitle); const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); if (!fileInfos.some(info => info.url === relativeUrl)) { From d497a48e50e02911afabe5c0c7128dc1fa9b77d2 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 12:33:07 +0100 Subject: [PATCH 07/19] updated the breadcrumb contents --- pages/builders/app-developers/bridging.mdx | 2 +- pages/builders/app-developers/contracts.mdx | 2 +- pages/builders/app-developers/tools.mdx | 2 +- .../builders/app-developers/transactions.mdx | 2 +- pages/builders/app-developers/tutorials.mdx | 2 +- pages/builders/cex-wallet-developers.mdx | 2 +- pages/builders/chain-operators.mdx | 2 +- .../chain-operators/configuration.mdx | 2 +- pages/builders/chain-operators/deploy.mdx | 2 +- pages/builders/chain-operators/features.mdx | 2 +- pages/builders/chain-operators/hacks.mdx | 2 +- pages/builders/chain-operators/management.mdx | 2 +- pages/builders/chain-operators/tools.mdx | 2 +- pages/builders/chain-operators/tutorials.mdx | 2 +- pages/builders/node-operators.mdx | 2 +- .../builders/node-operators/configuration.mdx | 2 +- pages/builders/node-operators/management.mdx | 2 +- pages/builders/node-operators/tutorials.mdx | 2 +- pages/builders/notices.mdx | 2 +- pages/builders/tools.mdx | 4 +- pages/builders/tools/build.mdx | 2 +- pages/builders/tools/connect.mdx | 2 +- pages/builders/tools/monitor.mdx | 2 +- pages/builders/tools/op-tools.mdx | 2 +- pages/chain/identity.mdx | 2 +- pages/chain/security.mdx | 2 +- pages/chain/testing.mdx | 2 +- pages/connect/contribute.mdx | 2 +- pages/connect/resources.mdx | 2 +- pages/stack/operators.mdx | 2 +- pages/stack/operators/features.mdx | 2 +- pages/stack/protocol.mdx | 4 +- pages/stack/protocol/fault-proofs.mdx | 2 +- pages/stack/protocol/features.mdx | 2 +- pages/stack/protocol/interop.mdx | 2 +- pages/stack/protocol/rollup.mdx | 2 +- pages/stack/security.mdx | 2 +- pages/stack/transactions.mdx | 2 +- utils/create-breadcrumbs.ts | 62 ++++++++++++++----- 39 files changed, 87 insertions(+), 55 deletions(-) diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx index 75004ef03..0505ec3c2 100644 --- a/pages/builders/app-developers/bridging.mdx +++ b/pages/builders/app-developers/bridging.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Bridging -Welcome to the Bridging section. Here you'll find resources and information related to 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. diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index 4fc916ac7..a00fe97df 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Contracts -Welcome to the Contracts section. Here you'll find resources and information related to 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. diff --git a/pages/builders/app-developers/tools.mdx b/pages/builders/app-developers/tools.mdx index efc7fff02..311e4c732 100644 --- a/pages/builders/app-developers/tools.mdx +++ b/pages/builders/app-developers/tools.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to 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. diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx index ca3fbba82..53c343741 100644 --- a/pages/builders/app-developers/transactions.mdx +++ b/pages/builders/app-developers/transactions.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Transactions -Welcome to the Transactions section. Here you'll find resources and information related to 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. diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx index 25d837e7a..130cc9271 100644 --- a/pages/builders/app-developers/tutorials.mdx +++ b/pages/builders/app-developers/tutorials.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to 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. diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 82d3e8b67..59a9f593c 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Cex Wallet Developers -Welcome to the Cex Wallet Developers section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators.mdx b/pages/builders/chain-operators.mdx index 813f1db8c..58f52f1fc 100644 --- a/pages/builders/chain-operators.mdx +++ b/pages/builders/chain-operators.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Chain Operators -Welcome to the Chain Operators section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/configuration.mdx b/pages/builders/chain-operators/configuration.mdx index 801a4e5c6..eeb44b78f 100644 --- a/pages/builders/chain-operators/configuration.mdx +++ b/pages/builders/chain-operators/configuration.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Configuration -Welcome to the Configuration section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/deploy.mdx b/pages/builders/chain-operators/deploy.mdx index 15c11257e..5ce741ce6 100644 --- a/pages/builders/chain-operators/deploy.mdx +++ b/pages/builders/chain-operators/deploy.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Deploy -Welcome to the Deploy section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx index 399ae00af..8b629beeb 100644 --- a/pages/builders/chain-operators/features.mdx +++ b/pages/builders/chain-operators/features.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx index 2bcf974da..2fcada575 100644 --- a/pages/builders/chain-operators/hacks.mdx +++ b/pages/builders/chain-operators/hacks.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Hacks -Welcome to the Hacks section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx index 26d6dcc62..cc1e0045a 100644 --- a/pages/builders/chain-operators/management.mdx +++ b/pages/builders/chain-operators/management.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Management -Welcome to the Management section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx index a688a5900..7f1b4c16a 100644 --- a/pages/builders/chain-operators/tools.mdx +++ b/pages/builders/chain-operators/tools.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to 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. diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx index 716917fb4..01726c074 100644 --- a/pages/builders/chain-operators/tutorials.mdx +++ b/pages/builders/chain-operators/tutorials.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to 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. diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx index 21f812bf2..bfc589137 100644 --- a/pages/builders/node-operators.mdx +++ b/pages/builders/node-operators.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Node Operators -Welcome to the Node Operators section. Here you'll find resources and information related to 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. diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx index af4862bb8..fc05dabfe 100644 --- a/pages/builders/node-operators/configuration.mdx +++ b/pages/builders/node-operators/configuration.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Configuration -Welcome to the Configuration section. Here you'll find resources and information related to 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. diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx index 5709df386..1bdf97e7c 100644 --- a/pages/builders/node-operators/management.mdx +++ b/pages/builders/node-operators/management.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Management -Welcome to the Management section. Here you'll find resources and information related to Management. +This section provides information on using blobs, node metrics and monitoring, using snap sync for node operators, node snapshots and node troubleshooting. You'll find api, reference, guide to help you understand and work with these topics. diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx index 1d32f0985..5d32f7fe8 100644 --- a/pages/builders/node-operators/tutorials.mdx +++ b/pages/builders/node-operators/tutorials.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tutorials -Welcome to the Tutorials section. Here you'll find resources and information related to Tutorials. +This section provides information on running an op mainnet node from source, running a node with docker, building a node from source and running an op sepolia node from source. You'll find tutorial, guide to help you understand and work with these topics. diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index e78cb48b0..e1c7e5150 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Notices -Welcome to the Notices section. Here you'll find resources and information related to Notices. +This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and sdk deprecation. You'll find overview, tutorial to help you understand and work with these topics. diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx index 6b85979c5..f9f600557 100644 --- a/pages/builders/tools.mdx +++ b/pages/builders/tools.mdx @@ -7,13 +7,13 @@ import { Card, Cards } from 'nextra/components' # Tools -Welcome to the Tools section. Here you'll find resources and information related to Tools. +This section provides information on build, connect, fjord fee parameter calculator, monitor, op tools and developer tools. You'll find guide, reference, tool, overview to help you understand and work with these topics. - + \ No newline at end of file diff --git a/pages/builders/tools/build.mdx b/pages/builders/tools/build.mdx index 75cad2a37..52c12a470 100644 --- a/pages/builders/tools/build.mdx +++ b/pages/builders/tools/build.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Build -Welcome to the Build section. Here you'll find resources and information related to Build. +This section provides information on account abstraction, block explorers, testnet faucets, op mainnet nft tools and oracles. You'll find guide, reference, tool, api to help you understand and work with these topics. diff --git a/pages/builders/tools/connect.mdx b/pages/builders/tools/connect.mdx index d4d079032..2e461c553 100644 --- a/pages/builders/tools/connect.mdx +++ b/pages/builders/tools/connect.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Connect -Welcome to the Connect section. Here you'll find resources and information related to Connect. +This section provides information on networks and rpc & node providers. You'll find reference to help you understand and work with these topics. diff --git a/pages/builders/tools/monitor.mdx b/pages/builders/tools/monitor.mdx index d7a559d9e..b7154ae3b 100644 --- a/pages/builders/tools/monitor.mdx +++ b/pages/builders/tools/monitor.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Monitor -Welcome to the Monitor section. Here you'll find resources and information related to Monitor. +This section provides information on analytics tools and accessing pre regenesis history. You'll find guide, tool to help you understand and work with these topics. diff --git a/pages/builders/tools/op-tools.mdx b/pages/builders/tools/op-tools.mdx index 9651722a5..1ae5b07dc 100644 --- a/pages/builders/tools/op-tools.mdx +++ b/pages/builders/tools/op-tools.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Op Tools -Welcome to the Op Tools section. Here you'll find resources and information related to Op Tools. +This section provides information on . \ No newline at end of file diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index d527f33b9..980a07dd9 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Identity -Welcome to the Identity section. Here you'll find resources and information related to Identity. +This section provides information on build decentralized identity apps with attestations, attestation apps, eas contracts, individuals, organizations, introduction, projects and schemas. You'll find guide, reference, overview to help you understand and work with these topics. diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index b792e5401..77d548773 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Security -Welcome to the Security section. Here you'll find resources and information related to Security. +This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index f71a3655b..103f5b325 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Testing -Welcome to the Testing section. Here you'll find resources and information related to 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. diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index 4572cb26c..549e138ff 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Contribute -Welcome to the Contribute section. Here you'll find resources and information related to Contribute. +This section provides information on contribute to optimism docs, contribute to the op stack and docs style guide. You'll find tutorial, overview, guide to help you understand and work with these topics. diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index afdf5a1e5..b689e047f 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Resources -Welcome to the Resources section. Here you'll find resources and information related to Resources. +This section provides information on . You'll find concept to help you understand and work with these topics. diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx index df960b5ed..b387dc9d6 100644 --- a/pages/stack/operators.mdx +++ b/pages/stack/operators.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Operators -Welcome to the Operators section. Here you'll find resources and information related to Operators. +This section provides information on . You'll find guide to help you understand and work with these topics. diff --git a/pages/stack/operators/features.mdx b/pages/stack/operators/features.mdx index d59bf04c4..bc015f4ab 100644 --- a/pages/stack/operators/features.mdx +++ b/pages/stack/operators/features.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to Features. +This section provides information on op txproxy and proxyd. You'll find guide to help you understand and work with these topics. diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx index 4644266af..adc2d3462 100644 --- a/pages/stack/protocol.mdx +++ b/pages/stack/protocol.mdx @@ -7,11 +7,11 @@ import { Card, Cards } from 'nextra/components' # Protocol -Welcome to the Protocol section. Here you'll find resources and information related to Protocol. +This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, reference, guide to help you understand and work with these topics. - + diff --git a/pages/stack/protocol/fault-proofs.mdx b/pages/stack/protocol/fault-proofs.mdx index 4bd276ac1..21ad9ad9a 100644 --- a/pages/stack/protocol/fault-proofs.mdx +++ b/pages/stack/protocol/fault-proofs.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Fault Proofs -Welcome to the Fault Proofs section. Here you'll find resources and information related to Fault Proofs. +This section provides information on fault proof vm: cannon, op challenger explainer, fault proofs explainer, fp system components, fault proofs mainnet security and fault proof vm: mips.sol. You'll find reference, guide, overview, api, introduction to help you understand and work with these topics. diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx index 5c119c1c9..bbf6dda79 100644 --- a/pages/stack/protocol/features.mdx +++ b/pages/stack/protocol/features.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Features -Welcome to the Features section. Here you'll find resources and information related to Features. +This section provides information on alt da mode explainer, custom gas token explainer and sendrawtransactionconditional explainer. You'll find guide to help you understand and work with these topics. diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx index d0e44d848..17cb34fcf 100644 --- a/pages/stack/protocol/interop.mdx +++ b/pages/stack/protocol/interop.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Interop -Welcome to the Interop section. Here you'll find resources and information related to Interop. +This section provides information on anatomy of a cross chain message, interoperability explainer and supersim multichain development environment. You'll find overview, guide, tool to help you understand and work with these topics. diff --git a/pages/stack/protocol/rollup.mdx b/pages/stack/protocol/rollup.mdx index 708a0cb74..9fa2cd3ea 100644 --- a/pages/stack/protocol/rollup.mdx +++ b/pages/stack/protocol/rollup.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Rollup -Welcome to the Rollup section. Here you'll find resources and information related to Rollup. +This section provides information on deposit flow, forced transaction, rollup protocol overview, transaction flow and withdrawal flow. You'll find guide, overview to help you understand and work with these topics. diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx index c591df29f..5a32b09d2 100644 --- a/pages/stack/security.mdx +++ b/pages/stack/security.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Security -Welcome to the Security section. Here you'll find resources and information related to Security. +This section provides information on op stack security faqs and pausing the bridge. diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx index da08d899f..57d6495e0 100644 --- a/pages/stack/transactions.mdx +++ b/pages/stack/transactions.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Transactions -Welcome to the Transactions section. Here you'll find resources and information related to Transactions. +This section provides information on . You'll find reference to help you understand and work with these topics. diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index ca3c896d9..00060b6a7 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -7,6 +7,7 @@ const rootDir: string = path.join(__dirname, '..', 'pages'); interface FileInfo { title: string; url: string; + content: string; } function toTitleCase(str: string): string { @@ -15,6 +16,35 @@ function toTitleCase(str: string): string { ).join(' '); } +function uniqueArray(arr: string[]): string[] { + return arr.filter((value, index, self) => self.indexOf(value) === index); +} + +function generateOverview(fileInfos: FileInfo[]): string { + const topics = fileInfos.map(file => file.title.toLowerCase()); + const uniqueTopics = uniqueArray(topics); + + let overview = `This section provides information on ${uniqueTopics.slice(0, -1).join(', ')}`; + if (uniqueTopics.length > 1) { + overview += ` and ${uniqueTopics[uniqueTopics.length - 1]}`; + } + overview += '. '; + + const keywordRegex = /\b(guide|tutorial|overview|introduction|tool|concept|api|reference)\b/i; + const keywords = uniqueArray( + fileInfos.flatMap(file => { + const matches = file.content.match(keywordRegex); + return matches ? matches.map(keyword => keyword.toLowerCase()) : []; + }) + ); + + if (keywords.length > 0) { + overview += `You'll find ${keywords.join(', ')} to help you understand and work with these topics.`; + } + + return overview; +} + const createMdxFile = async (parentFolderPath: string, folderName: string): Promise => { const folderPath = path.join(parentFolderPath, folderName); const files = await fs.readdir(folderPath); @@ -25,20 +55,6 @@ const createMdxFile = async (parentFolderPath: string, folderName: string): Prom const title = toTitleCase(folderName); - let content = `--- -title: ${title} -lang: en-US ---- - -import { Card, Cards } from 'nextra/components' - -# ${title} - -Welcome to the ${title} section. Here you'll find resources and information related to ${title}. - - -`; - const fileInfos: FileInfo[] = []; for (const file of mdFiles) { @@ -49,10 +65,26 @@ Welcome to the ${title} section. Here you'll find resources and information rela const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); if (!fileInfos.some(info => info.url === relativeUrl)) { - fileInfos.push({ title: fileTitle, url: relativeUrl }); + fileInfos.push({ title: fileTitle, url: relativeUrl, content: fileContent }); } } + const overview = generateOverview(fileInfos); + + let content = `--- +title: ${title} +lang: en-US +--- + +import { Card, Cards } from 'nextra/components' + +# ${title} + +${overview} + + +`; + fileInfos.forEach(({ title, url }) => { content += ` \n`; }); From 081c3293ef6f42a2e09c0fba90205619fc5062da Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 13:02:07 +0100 Subject: [PATCH 08/19] remove comments --- utils/create-breadcrumbs.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index 00060b6a7..fc123a605 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -102,7 +102,6 @@ ${overview} return; } } catch (error) { - // File doesn't exist, we'll create it } await fs.writeFile(mdxFilePath, content); @@ -136,5 +135,4 @@ const main = async (): Promise => { main().catch(console.error); -// Log the root directory for debugging console.log('Root directory:', rootDir); \ No newline at end of file From b832d2f6de4892ac33628ba81914da876491d137 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 18 Oct 2024 13:02:40 +0100 Subject: [PATCH 09/19] fix lint issues --- pages/builders/app-developers.mdx | 10 ++++++++-- pages/builders/app-developers/bridging.mdx | 5 ++++- pages/builders/app-developers/contracts.mdx | 4 +++- pages/builders/app-developers/tools.mdx | 3 ++- pages/builders/app-developers/transactions.mdx | 6 +++++- pages/builders/app-developers/tutorials.mdx | 11 ++++++++++- pages/builders/cex-wallet-developers.mdx | 3 ++- pages/builders/chain-operators.mdx | 10 +++++++++- pages/builders/chain-operators/configuration.mdx | 5 ++++- pages/builders/chain-operators/deploy.mdx | 4 +++- pages/builders/chain-operators/features.mdx | 6 +++++- pages/builders/chain-operators/hacks.mdx | 7 ++++++- pages/builders/chain-operators/management.mdx | 7 ++++++- pages/builders/chain-operators/tools.mdx | 6 +++++- pages/builders/chain-operators/tutorials.mdx | 7 ++++++- pages/builders/node-operators.mdx | 9 ++++++++- pages/builders/node-operators/configuration.mdx | 4 +++- pages/builders/node-operators/management.mdx | 6 +++++- pages/builders/node-operators/tutorials.mdx | 5 ++++- pages/builders/notices.mdx | 4 +++- pages/builders/tools.mdx | 7 ++++++- pages/builders/tools/build.mdx | 6 +++++- pages/builders/tools/connect.mdx | 3 ++- pages/builders/tools/monitor.mdx | 3 ++- pages/builders/tools/op-tools.mdx | 5 ++--- pages/chain/identity.mdx | 9 ++++++++- pages/chain/security.mdx | 6 ++++-- pages/chain/testing.mdx | 3 ++- pages/connect/contribute.mdx | 4 +++- pages/connect/resources.mdx | 2 +- pages/stack/operators.mdx | 2 +- pages/stack/operators/features.mdx | 3 ++- pages/stack/protocol.mdx | 7 ++++++- pages/stack/protocol/fault-proofs.mdx | 7 ++++++- pages/stack/protocol/features.mdx | 4 +++- pages/stack/protocol/interop.mdx | 4 +++- pages/stack/protocol/rollup.mdx | 6 +++++- pages/stack/security.mdx | 5 +++-- pages/stack/transactions.mdx | 2 +- words.txt | 6 ++++++ 40 files changed, 172 insertions(+), 44 deletions(-) diff --git a/pages/builders/app-developers.mdx b/pages/builders/app-developers.mdx index 671d45bf2..2b1fb38e2 100644 --- a/pages/builders/app-developers.mdx +++ b/pages/builders/app-developers.mdx @@ -7,15 +7,21 @@ 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. +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 + + + + + + - \ No newline at end of file + diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx index 0505ec3c2..fffb0d890 100644 --- a/pages/builders/app-developers/bridging.mdx +++ b/pages/builders/app-developers/bridging.mdx @@ -11,7 +11,10 @@ This section provides information on bridging basics, custom bridges, sending da + + + - \ No newline at end of file + diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index a00fe97df..6aa071fe8 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -11,6 +11,8 @@ This section provides information on solidity compatibility, contract optimizati + + - \ No newline at end of file + diff --git a/pages/builders/app-developers/tools.mdx b/pages/builders/app-developers/tools.mdx index 311e4c732..be665e956 100644 --- a/pages/builders/app-developers/tools.mdx +++ b/pages/builders/app-developers/tools.mdx @@ -11,5 +11,6 @@ This section provides information on open source code repo for op stack builders + - \ No newline at end of file + diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx index 53c343741..6350d183a 100644 --- a/pages/builders/app-developers/transactions.mdx +++ b/pages/builders/app-developers/transactions.mdx @@ -11,8 +11,12 @@ This section provides information on estimating transaction fees on op mainnet, + + + + - \ No newline at end of file + diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx index 130cc9271..874941a77 100644 --- a/pages/builders/app-developers/tutorials.mdx +++ b/pages/builders/app-developers/tutorials.mdx @@ -11,13 +11,22 @@ This section provides information on bridging erc 20 tokens to op mainnet with t + + + + + + + + + - \ No newline at end of file + diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 59a9f593c..57f632b38 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -11,5 +11,6 @@ This section provides information on supporting op mainnet in your exchange and + - \ No newline at end of file + diff --git a/pages/builders/chain-operators.mdx b/pages/builders/chain-operators.mdx index 58f52f1fc..3b54c31da 100644 --- a/pages/builders/chain-operators.mdx +++ b/pages/builders/chain-operators.mdx @@ -11,12 +11,20 @@ This section provides information on chain architecture, configuration, deploy, + + + + + + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/configuration.mdx b/pages/builders/chain-operators/configuration.mdx index eeb44b78f..b4267cebb 100644 --- a/pages/builders/chain-operators/configuration.mdx +++ b/pages/builders/chain-operators/configuration.mdx @@ -11,7 +11,10 @@ This section provides information on batcher configuration, chain operator confi + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/deploy.mdx b/pages/builders/chain-operators/deploy.mdx index 5ce741ce6..100f7bf78 100644 --- a/pages/builders/chain-operators/deploy.mdx +++ b/pages/builders/chain-operators/deploy.mdx @@ -11,6 +11,8 @@ This section provides information on op stack genesis creation, op stack deploym + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx index 8b629beeb..57da4c982 100644 --- a/pages/builders/chain-operators/features.mdx +++ b/pages/builders/chain-operators/features.mdx @@ -11,8 +11,12 @@ This section provides information on how to run an alt da mode chain, bridged us + + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx index 2fcada575..2ec661074 100644 --- a/pages/builders/chain-operators/hacks.mdx +++ b/pages/builders/chain-operators/hacks.mdx @@ -11,9 +11,14 @@ This section provides information on data availability hacks, derivation hacks, + + + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx index cc1e0045a..57c755c70 100644 --- a/pages/builders/chain-operators/management.mdx +++ b/pages/builders/chain-operators/management.mdx @@ -11,9 +11,14 @@ This section provides information on chain operator best practices, using blobs, + + + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx index 7f1b4c16a..ee682af50 100644 --- a/pages/builders/chain-operators/tools.mdx +++ b/pages/builders/chain-operators/tools.mdx @@ -11,8 +11,12 @@ This section provides information on chain monitoring options, deploying a block + + + + - \ No newline at end of file + diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx index 01726c074..23206d955 100644 --- a/pages/builders/chain-operators/tutorials.mdx +++ b/pages/builders/chain-operators/tutorials.mdx @@ -11,9 +11,14 @@ This section provides information on adding attributes to the derivation functio + + + + + - \ No newline at end of file + diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx index bfc589137..3e1f573fc 100644 --- a/pages/builders/node-operators.mdx +++ b/pages/builders/node-operators.mdx @@ -11,11 +11,18 @@ This section provides information on node architecture, configuration, json rpc + + + + + + + - \ No newline at end of file + diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx index fc05dabfe..97f7ef5d5 100644 --- a/pages/builders/node-operators/configuration.mdx +++ b/pages/builders/node-operators/configuration.mdx @@ -11,6 +11,8 @@ This section provides information on node base configuration, consensus layer co + + - \ No newline at end of file + diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx index 1bdf97e7c..e2ca7e714 100644 --- a/pages/builders/node-operators/management.mdx +++ b/pages/builders/node-operators/management.mdx @@ -11,8 +11,12 @@ This section provides information on using blobs, node metrics and monitoring, u + + + + - \ No newline at end of file + diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx index 5d32f7fe8..5ef234f07 100644 --- a/pages/builders/node-operators/tutorials.mdx +++ b/pages/builders/node-operators/tutorials.mdx @@ -11,7 +11,10 @@ This section provides information on running an op mainnet node from source, run + + + - \ No newline at end of file + diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index e1c7e5150..edcabfd6e 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -11,6 +11,8 @@ This section provides information on preparing for fault proofs breaking changes + + - \ No newline at end of file + diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx index f9f600557..0117233b6 100644 --- a/pages/builders/tools.mdx +++ b/pages/builders/tools.mdx @@ -11,9 +11,14 @@ This section provides information on build, connect, fjord fee parameter calcula + + + + + - \ No newline at end of file + diff --git a/pages/builders/tools/build.mdx b/pages/builders/tools/build.mdx index 52c12a470..70bcb28fd 100644 --- a/pages/builders/tools/build.mdx +++ b/pages/builders/tools/build.mdx @@ -11,8 +11,12 @@ This section provides information on account abstraction, block explorers, testn + + + + - \ No newline at end of file + diff --git a/pages/builders/tools/connect.mdx b/pages/builders/tools/connect.mdx index 2e461c553..d0d8d2967 100644 --- a/pages/builders/tools/connect.mdx +++ b/pages/builders/tools/connect.mdx @@ -11,5 +11,6 @@ This section provides information on networks and rpc & node providers. You'll f + - \ No newline at end of file + diff --git a/pages/builders/tools/monitor.mdx b/pages/builders/tools/monitor.mdx index b7154ae3b..995ffb8bd 100644 --- a/pages/builders/tools/monitor.mdx +++ b/pages/builders/tools/monitor.mdx @@ -11,5 +11,6 @@ This section provides information on analytics tools and accessing pre regenesis + - \ No newline at end of file + diff --git a/pages/builders/tools/op-tools.mdx b/pages/builders/tools/op-tools.mdx index 1ae5b07dc..7d6a5c7af 100644 --- a/pages/builders/tools/op-tools.mdx +++ b/pages/builders/tools/op-tools.mdx @@ -7,7 +7,6 @@ import { Card, Cards } from 'nextra/components' # Op Tools -This section provides information on . +This section provides information on . - - \ No newline at end of file + diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index 980a07dd9..8e9494356 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -11,11 +11,18 @@ This section provides information on build decentralized identity apps with atte + + + + + + + - \ No newline at end of file + diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index 77d548773..aae3f716a 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -7,10 +7,12 @@ 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. +This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. + + - \ No newline at end of file + diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index 103f5b325..0e18191ba 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -11,5 +11,6 @@ This section provides information on running a local development environment and + - \ No newline at end of file + diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index 549e138ff..551889623 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -11,6 +11,8 @@ This section provides information on contribute to optimism docs, contribute to + + - \ No newline at end of file + diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index b689e047f..f922a7f4f 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -11,4 +11,4 @@ This section provides information on . You'll find concept to help you understan - \ No newline at end of file + diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx index b387dc9d6..6fba143cd 100644 --- a/pages/stack/operators.mdx +++ b/pages/stack/operators.mdx @@ -11,4 +11,4 @@ This section provides information on . You'll find guide to help you understand - \ No newline at end of file + diff --git a/pages/stack/operators/features.mdx b/pages/stack/operators/features.mdx index bc015f4ab..0e3865182 100644 --- a/pages/stack/operators/features.mdx +++ b/pages/stack/operators/features.mdx @@ -11,5 +11,6 @@ This section provides information on op txproxy and proxyd. You'll find guide to + - \ No newline at end of file + diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx index adc2d3462..ace2c58a4 100644 --- a/pages/stack/protocol.mdx +++ b/pages/stack/protocol.mdx @@ -11,9 +11,14 @@ This section provides information on derivation pipeline, fault proofs, features + + + + + - \ No newline at end of file + diff --git a/pages/stack/protocol/fault-proofs.mdx b/pages/stack/protocol/fault-proofs.mdx index 21ad9ad9a..2d21c4d0c 100644 --- a/pages/stack/protocol/fault-proofs.mdx +++ b/pages/stack/protocol/fault-proofs.mdx @@ -11,9 +11,14 @@ This section provides information on fault proof vm: cannon, op challenger expla + + + + + - \ No newline at end of file + diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx index bbf6dda79..a96559d8e 100644 --- a/pages/stack/protocol/features.mdx +++ b/pages/stack/protocol/features.mdx @@ -11,6 +11,8 @@ This section provides information on alt da mode explainer, custom gas token exp + + - \ No newline at end of file + diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx index 17cb34fcf..bcb1ecf0c 100644 --- a/pages/stack/protocol/interop.mdx +++ b/pages/stack/protocol/interop.mdx @@ -11,6 +11,8 @@ This section provides information on anatomy of a cross chain message, interoper + + - \ No newline at end of file + diff --git a/pages/stack/protocol/rollup.mdx b/pages/stack/protocol/rollup.mdx index 9fa2cd3ea..487f5882e 100644 --- a/pages/stack/protocol/rollup.mdx +++ b/pages/stack/protocol/rollup.mdx @@ -11,8 +11,12 @@ This section provides information on deposit flow, forced transaction, rollup pr + + + + - \ No newline at end of file + diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx index 5a32b09d2..2ca1e092a 100644 --- a/pages/stack/security.mdx +++ b/pages/stack/security.mdx @@ -7,9 +7,10 @@ import { Card, Cards } from 'nextra/components' # Security -This section provides information on op stack security faqs and pausing the bridge. +This section provides information on op stack security faqs and pausing the bridge. + - \ No newline at end of file + diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx index 57d6495e0..198b3838a 100644 --- a/pages/stack/transactions.mdx +++ b/pages/stack/transactions.mdx @@ -11,4 +11,4 @@ This section provides information on . You'll find reference to help you underst - \ No newline at end of file + diff --git a/words.txt b/words.txt index f325c6327..f0363cc63 100644 --- a/words.txt +++ b/words.txt @@ -205,6 +205,7 @@ MTLO MULT multiaddr Multichain +multichain multiclient multisigs MULTU @@ -284,6 +285,7 @@ productionize productionized Protip Proxied +Proxyd proxyd pseudorandomly QRNG @@ -317,6 +319,8 @@ safedb Schnorr secp SELFDESTRUCT +Sendrawtransactionconditional +sendrawtransactionconditional seqnr SEQUENCERHTTP sequencerhttp @@ -365,8 +369,10 @@ trustlessly trustrpc txfeecap txmgr +txns TXPOOL txpool +Txproxy txproxy uncountered Unprotect From e10fafade87d040b3f86fe819ed57b8cec8c60aa Mon Sep 17 00:00:00 2001 From: soyboy <85043086+sbvegan@users.noreply.github.com> Date: Mon, 21 Oct 2024 20:55:06 -0600 Subject: [PATCH 10/19] Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- pages/builders.mdx | 2 +- pages/builders/app-developers.mdx | 1 + pages/builders/app-developers/bridging.mdx | 1 + .../app-developers/bridging/custom-bridge.mdx | 4 ++-- pages/builders/app-developers/contracts.mdx | 9 +++++---- pages/builders/app-developers/tools.mdx | 7 ++++--- pages/builders/app-developers/transactions.mdx | 13 +++++++------ pages/builders/app-developers/tutorials.mdx | 2 +- pages/builders/cex-wallet-developers.mdx | 4 ++-- pages/builders/chain-operators.mdx | 9 +++++---- pages/builders/chain-operators/configuration.mdx | 3 ++- pages/builders/chain-operators/deploy.mdx | 3 ++- pages/builders/chain-operators/features.mdx | 2 +- pages/builders/chain-operators/hacks.mdx | 2 +- pages/builders/chain-operators/management.mdx | 2 +- pages/builders/chain-operators/tools.mdx | 2 +- pages/builders/node-operators/management.mdx | 2 +- pages/builders/node-operators/tutorials.mdx | 2 +- pages/builders/notices.mdx | 2 +- pages/chain/identity.mdx | 6 +++--- pages/chain/testing.mdx | 2 +- pages/connect/contribute.mdx | 2 +- pages/connect/resources.mdx | 2 +- pages/stack/protocol/features.mdx | 2 +- 24 files changed, 47 insertions(+), 39 deletions(-) diff --git a/pages/builders.mdx b/pages/builders.mdx index 320370a98..810cb0fcd 100644 --- a/pages/builders.mdx +++ b/pages/builders.mdx @@ -12,7 +12,7 @@ The fixture is the main abstraction in React Cosmos. It represents a component e - + diff --git a/pages/builders/app-developers.mdx b/pages/builders/app-developers.mdx index 2b1fb38e2..4bf0f90ce 100644 --- a/pages/builders/app-developers.mdx +++ b/pages/builders/app-developers.mdx @@ -1,6 +1,7 @@ --- 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' diff --git a/pages/builders/app-developers/bridging.mdx b/pages/builders/app-developers/bridging.mdx index fffb0d890..893cb6db6 100644 --- a/pages/builders/app-developers/bridging.mdx +++ b/pages/builders/app-developers/bridging.mdx @@ -1,6 +1,7 @@ --- 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' diff --git a/pages/builders/app-developers/bridging/custom-bridge.mdx b/pages/builders/app-developers/bridging/custom-bridge.mdx index d686bae85..23ea17319 100644 --- a/pages/builders/app-developers/bridging/custom-bridge.mdx +++ b/pages/builders/app-developers/bridging/custom-bridge.mdx @@ -15,7 +15,7 @@ This guide provides important information you should be aware of when building a 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-tokennnnyd) is often sufficient for projects that need more flexibility. + [Building a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token) is often sufficient for projects that need more flexibility. ## Guidelines @@ -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-bridgedgh). +You can read more about the design of the Standard Bridge in the guide on [Using the Standard Bridge](./standard-bridge). ## The Superchain Token List diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index 6aa071fe8..06e1b874a 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -1,18 +1,19 @@ --- title: Contracts lang: en-US +description: Information on Solidity compatibility, contract optimization, and system contracts for OP Mainnet. --- 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. +This section provides information on Solidity compatibility, contract optimization on OP Mainnet, and using OP Mainnet system contracts. You'll find guides and tutorials to help you understand and work with these topics. - + - + - + diff --git a/pages/builders/app-developers/tools.mdx b/pages/builders/app-developers/tools.mdx index be665e956..7aeb81f23 100644 --- a/pages/builders/app-developers/tools.mdx +++ b/pages/builders/app-developers/tools.mdx @@ -1,16 +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 repo for op stack builders and supersim. You'll find reference to help you understand and work with these topics. +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. - + - + diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx index 6350d183a..847b05e02 100644 --- a/pages/builders/app-developers/transactions.mdx +++ b/pages/builders/app-developers/transactions.mdx @@ -1,22 +1,23 @@ --- title: Transactions lang: en-US +description: Guide to understanding and working with transactions on OP Mainnet, including fee estimation, gas parameters, and troubleshooting. --- 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. +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. - + - + - + - + - + diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx index 874941a77..2eca7c7ff 100644 --- a/pages/builders/app-developers/tutorials.mdx +++ b/pages/builders/app-developers/tutorials.mdx @@ -1,10 +1,10 @@ --- 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. diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 57f632b38..4c9207779 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -5,9 +5,9 @@ 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. +This section provides information on supporting OP Stack in your exchange and supporting OP Stack in your wallet. You'll find guides to help you understand and work with these topics. diff --git a/pages/builders/chain-operators.mdx b/pages/builders/chain-operators.mdx index 3b54c31da..872c69d26 100644 --- a/pages/builders/chain-operators.mdx +++ b/pages/builders/chain-operators.mdx @@ -1,20 +1,21 @@ --- 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 +# 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. +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. - + @@ -22,7 +23,7 @@ This section provides information on chain architecture, configuration, deploy, - + diff --git a/pages/builders/chain-operators/configuration.mdx b/pages/builders/chain-operators/configuration.mdx index b4267cebb..f8ea320f4 100644 --- a/pages/builders/chain-operators/configuration.mdx +++ b/pages/builders/chain-operators/configuration.mdx @@ -1,13 +1,14 @@ --- 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. You'll find api, overview to help you understand and work with these topics. +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. diff --git a/pages/builders/chain-operators/deploy.mdx b/pages/builders/chain-operators/deploy.mdx index 100f7bf78..87e4184f6 100644 --- a/pages/builders/chain-operators/deploy.mdx +++ b/pages/builders/chain-operators/deploy.mdx @@ -1,13 +1,14 @@ --- 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, op stack deployment overview and op stack smart contract deployment. You'll find guide, overview to help you understand and work with these topics. +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. diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx index 57da4c982..00fc79e11 100644 --- a/pages/builders/chain-operators/features.mdx +++ b/pages/builders/chain-operators/features.mdx @@ -7,7 +7,7 @@ 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. +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. diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx index 2ec661074..b64c3c47e 100644 --- a/pages/builders/chain-operators/hacks.mdx +++ b/pages/builders/chain-operators/hacks.mdx @@ -7,7 +7,7 @@ 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. +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. diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx index 57c755c70..6e3f29293 100644 --- a/pages/builders/chain-operators/management.mdx +++ b/pages/builders/chain-operators/management.mdx @@ -7,7 +7,7 @@ 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. +This section provides information on chain operator best practices, using blobs, managing keys, rollup operations, using snap sync for chain operators, and troubleshooting chain operations. You'll find guides and tutorials to help you understand and work with these topics. diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx index ee682af50..b91e74678 100644 --- a/pages/builders/chain-operators/tools.mdx +++ b/pages/builders/chain-operators/tools.mdx @@ -7,7 +7,7 @@ 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. +This section provides information on chain monitoring options, deploying a block explorer, configuring a challenger for your chain, conductor, and deployer. You'll find guides, overviews, and tools to help you understand and work with these topics. diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx index e2ca7e714..76ac7721c 100644 --- a/pages/builders/node-operators/management.mdx +++ b/pages/builders/node-operators/management.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Management -This section provides information on using blobs, node metrics and monitoring, using snap sync for node operators, node snapshots and node troubleshooting. You'll find api, reference, guide to help you understand and work with these topics. +This section provides information on using blobs, node metrics and monitoring, snap sync for node operators, node snapshots, and troubleshooting. Users will find APIs, references, and guides to help understand and work with these topics. diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx index 5ef234f07..e9d9972f9 100644 --- a/pages/builders/node-operators/tutorials.mdx +++ b/pages/builders/node-operators/tutorials.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Tutorials -This section provides information on running an op mainnet node from source, running a node with docker, building a node from source and running an op sepolia node from source. You'll find tutorial, guide to help you understand and work with these topics. +This section provides information on various node operations. It covers running an OP Mainnet node from source, running a node with Docker, building a node from source, and running an OP Sepolia node from source. You'll find tutorials and guides to help you understand and work with these topics. diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index edcabfd6e..fb6895d3e 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Notices -This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and sdk deprecation. You'll find overview, tutorial to help you understand and work with these topics. +This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes, and SDK deprecation. You'll find an overview and tutorials to help you understand and work with these topics. diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index 8e9494356..fb4a663f6 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -10,11 +10,11 @@ import { Card, Cards } from 'nextra/components' This section provides information on build decentralized identity apps with attestations, attestation apps, eas contracts, individuals, organizations, introduction, projects and schemas. You'll find guide, reference, overview to help you understand and work with these topics. - + - + - + diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index 0e18191ba..d46f79c9d 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -7,7 +7,7 @@ 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. +This section provides information on running a local development environment and testing apps for OP Mainnet. You'll find tutorials and guides to help you understand and work with these topics. diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index 551889623..b942d205e 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Contribute -This section provides information on contribute to optimism docs, contribute to the op stack and docs style guide. You'll find tutorial, overview, guide to help you understand and work with these topics. +This section provides information on contributing to Optimism docs, contributing to the OP Stack, and the docs style guide. Users will find tutorials, overviews, and guides to help them understand and work with these topics. diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index f922a7f4f..a8872f645 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -7,7 +7,7 @@ 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. +This section provides information on various resources related to the OP Stack ecosystem. It includes concepts to help users understand and work with these topics. diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx index a96559d8e..be264266a 100644 --- a/pages/stack/protocol/features.mdx +++ b/pages/stack/protocol/features.mdx @@ -7,7 +7,7 @@ import { Card, Cards } from 'nextra/components' # Features -This section provides information on alt da mode explainer, custom gas token explainer and sendrawtransactionconditional explainer. You'll find guide to help you understand and work with these topics. +This section provides information on Alt DA Mode Explainer, Custom Gas Token Explainer, and SendRawTransactionConditional Explainer. You'll find a guide to help you understand and work with these topics. From 2b7cbea961fb91a4e1f342f91cf4c123fb676292 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 12:49:02 +0100 Subject: [PATCH 11/19] Add descriptions --- .../app-developers/tools/supersim.mdx | 3 + .../app-developers/transactions/fees.mdx | 3 + pages/builders/cex-wallet-developers.mdx | 8 +- pages/builders/chain-operators/features.mdx | 3 + pages/builders/chain-operators/hacks.mdx | 3 + pages/builders/chain-operators/management.mdx | 3 + pages/builders/chain-operators/tools.mdx | 3 + pages/builders/chain-operators/tutorials.mdx | 3 + pages/builders/node-operators.mdx | 14 +-- .../builders/node-operators/configuration.mdx | 3 + pages/builders/node-operators/management.mdx | 3 + pages/builders/node-operators/tutorials.mdx | 3 + pages/builders/notices.mdx | 9 +- pages/builders/tools.mdx | 10 +- pages/builders/tools/build.mdx | 3 + pages/builders/tools/connect.mdx | 3 + pages/builders/tools/connect/networks.mdx | 3 + pages/builders/tools/monitor.mdx | 3 + pages/builders/tools/op-tools.mdx | 3 + pages/chain/identity.mdx | 22 ++-- pages/chain/security.mdx | 7 +- pages/chain/testing.mdx | 6 +- pages/connect/contribute.mdx | 11 +- pages/connect/resources.mdx | 5 +- pages/stack/operators.mdx | 3 +- pages/stack/operators/features.mdx | 3 + pages/stack/protocol.mdx | 10 +- pages/stack/protocol/fault-proofs.mdx | 3 + pages/stack/protocol/features.mdx | 3 + pages/stack/protocol/interop.mdx | 3 + pages/stack/protocol/rollup.mdx | 3 + pages/stack/security.mdx | 6 +- pages/stack/transactions.mdx | 3 +- utils/create-breadcrumbs.ts | 108 +++++++++++++++--- 34 files changed, 197 insertions(+), 85 deletions(-) diff --git a/pages/builders/app-developers/tools/supersim.mdx b/pages/builders/app-developers/tools/supersim.mdx index f25adb1bc..e76629fc2 100644 --- a/pages/builders/app-developers/tools/supersim.mdx +++ b/pages/builders/app-developers/tools/supersim.mdx @@ -1,4 +1,7 @@ --- +description: >- + Learn about supersim in the Optimism ecosystem. This guide provides detailed + information and resources about supersim. --- import Supersim from '@/pages/stack/protocol/interop/supersim.mdx' diff --git a/pages/builders/app-developers/transactions/fees.mdx b/pages/builders/app-developers/transactions/fees.mdx index 09af8f1c0..2808ca1f6 100644 --- a/pages/builders/app-developers/transactions/fees.mdx +++ b/pages/builders/app-developers/transactions/fees.mdx @@ -1,4 +1,7 @@ --- +description: >- + Learn about fees in the Optimism ecosystem. This guide provides detailed + information and resources about fees. --- import TransactionFees from '@/pages/stack/transactions/fees.mdx' diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 4c9207779..a5b8c0a56 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -1,16 +1,16 @@ --- title: Cex Wallet Developers +description: 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... lang: en-US --- import { Card, Cards } from 'nextra/components' -# CEX Wallet Developers +# Cex Wallet Developers -This section provides information on supporting OP Stack in your exchange and supporting OP Stack in your wallet. You'll find guides to help you understand and work with these topics. +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. - - + \ No newline at end of file diff --git a/pages/builders/chain-operators/features.mdx b/pages/builders/chain-operators/features.mdx index 00fc79e11..e2a22d516 100644 --- a/pages/builders/chain-operators/features.mdx +++ b/pages/builders/chain-operators/features.mdx @@ -1,6 +1,9 @@ --- 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' diff --git a/pages/builders/chain-operators/hacks.mdx b/pages/builders/chain-operators/hacks.mdx index b64c3c47e..5a30e8912 100644 --- a/pages/builders/chain-operators/hacks.mdx +++ b/pages/builders/chain-operators/hacks.mdx @@ -1,6 +1,9 @@ --- 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' diff --git a/pages/builders/chain-operators/management.mdx b/pages/builders/chain-operators/management.mdx index 6e3f29293..df32978e5 100644 --- a/pages/builders/chain-operators/management.mdx +++ b/pages/builders/chain-operators/management.mdx @@ -1,6 +1,9 @@ --- title: Management lang: en-US +description: >- + Learn about management in the Optimism ecosystem. This guide provides detailed + information and resources about management. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/chain-operators/tools.mdx b/pages/builders/chain-operators/tools.mdx index b91e74678..1b8103c61 100644 --- a/pages/builders/chain-operators/tools.mdx +++ b/pages/builders/chain-operators/tools.mdx @@ -1,6 +1,9 @@ --- title: Tools lang: en-US +description: >- + Learn about tools in the Optimism ecosystem. This guide provides detailed + information and resources about tools. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx index 23206d955..6f99a4661 100644 --- a/pages/builders/chain-operators/tutorials.mdx +++ b/pages/builders/chain-operators/tutorials.mdx @@ -1,6 +1,9 @@ --- title: Tutorials lang: en-US +description: >- + Learn about tutorials in the Optimism ecosystem. This guide provides detailed + information and resources about tutorials. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx index 3e1f573fc..e9535def2 100644 --- a/pages/builders/node-operators.mdx +++ b/pages/builders/node-operators.mdx @@ -1,5 +1,6 @@ --- title: Node Operators +description: This section provides information on node architecture, configuration, json rpc api, management, network upgrades, node software releases, how to run... lang: en-US --- @@ -7,22 +8,15 @@ 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. +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. - - - - - - + - - - + \ No newline at end of file diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx index 97f7ef5d5..de45fff09 100644 --- a/pages/builders/node-operators/configuration.mdx +++ b/pages/builders/node-operators/configuration.mdx @@ -1,6 +1,9 @@ --- title: Configuration lang: en-US +description: >- + Learn about configuration in the Optimism ecosystem. This guide provides + detailed information and resources about configuration. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/node-operators/management.mdx b/pages/builders/node-operators/management.mdx index 76ac7721c..428a4593d 100644 --- a/pages/builders/node-operators/management.mdx +++ b/pages/builders/node-operators/management.mdx @@ -1,6 +1,9 @@ --- title: Management lang: en-US +description: >- + Learn about management in the Optimism ecosystem. This guide provides detailed + information and resources about management. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/node-operators/tutorials.mdx b/pages/builders/node-operators/tutorials.mdx index e9d9972f9..de908fd0f 100644 --- a/pages/builders/node-operators/tutorials.mdx +++ b/pages/builders/node-operators/tutorials.mdx @@ -1,6 +1,9 @@ --- title: Tutorials lang: en-US +description: >- + Learn about tutorials in the Optimism ecosystem. This guide provides detailed + information and resources about tutorials. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index fb6895d3e..2f9534e95 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -1,5 +1,6 @@ --- title: Notices +description: This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and deprecation of the... lang: en-US --- @@ -7,12 +8,10 @@ import { Card, Cards } from 'nextra/components' # Notices -This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes, and SDK deprecation. You'll find an overview and tutorials to help you understand and work with these topics. +This section provides information on preparing for fault proofs breaking changes, preparing for granite breaking changes and deprecation of the optimism sdk. You'll find overview, tutorial to help you understand and work with these topics. - - - - + + \ No newline at end of file diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx index 0117233b6..3bebb9d3b 100644 --- a/pages/builders/tools.mdx +++ b/pages/builders/tools.mdx @@ -1,5 +1,6 @@ --- 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,... lang: en-US --- @@ -7,18 +8,13 @@ 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, reference, tool, overview to help you understand and work with these topics. +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. - - - - - - + \ No newline at end of file diff --git a/pages/builders/tools/build.mdx b/pages/builders/tools/build.mdx index 70bcb28fd..0d039842e 100644 --- a/pages/builders/tools/build.mdx +++ b/pages/builders/tools/build.mdx @@ -1,6 +1,9 @@ --- title: Build lang: en-US +description: >- + Learn about build in the Optimism ecosystem. This guide provides detailed + information and resources about build. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/tools/connect.mdx b/pages/builders/tools/connect.mdx index d0d8d2967..50154b1f4 100644 --- a/pages/builders/tools/connect.mdx +++ b/pages/builders/tools/connect.mdx @@ -1,6 +1,9 @@ --- title: Connect lang: en-US +description: >- + Learn about connect in the Optimism ecosystem. This guide provides detailed + information and resources about connect. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/tools/connect/networks.mdx b/pages/builders/tools/connect/networks.mdx index f7a9e91cb..f43ede8e7 100644 --- a/pages/builders/tools/connect/networks.mdx +++ b/pages/builders/tools/connect/networks.mdx @@ -1,4 +1,7 @@ --- +description: >- + Learn about networks in the Optimism ecosystem. This guide provides detailed + information and resources about networks. --- import OPNetworks from '@/pages/chain/networks.mdx' diff --git a/pages/builders/tools/monitor.mdx b/pages/builders/tools/monitor.mdx index 995ffb8bd..848483480 100644 --- a/pages/builders/tools/monitor.mdx +++ b/pages/builders/tools/monitor.mdx @@ -1,6 +1,9 @@ --- title: Monitor lang: en-US +description: >- + Learn about monitor in the Optimism ecosystem. This guide provides detailed + information and resources about monitor. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/tools/op-tools.mdx b/pages/builders/tools/op-tools.mdx index 7d6a5c7af..4335cef41 100644 --- a/pages/builders/tools/op-tools.mdx +++ b/pages/builders/tools/op-tools.mdx @@ -1,6 +1,9 @@ --- title: Op Tools lang: en-US +description: >- + Learn about op tools in the Optimism ecosystem. This guide provides detailed + information and resources about op tools. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index fb4a663f6..faff79b4b 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -1,5 +1,6 @@ --- title: Identity +description: This section provides information on about attestations, attestation apps, contracts (eas), individual identity, organizations, identity overview,... lang: en-US --- @@ -7,22 +8,15 @@ import { Card, Cards } from 'nextra/components' # Identity -This section provides information on build decentralized identity apps with attestations, attestation apps, eas contracts, individuals, organizations, introduction, projects and schemas. You'll find guide, reference, overview to help you understand and work with these topics. +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. - - - - - - - - + + + + - - - + - - + \ No newline at end of file diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index aae3f716a..7b4a79f04 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -1,5 +1,6 @@ --- title: Security +description: This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. lang: en-US --- @@ -7,12 +8,10 @@ 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. +This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. - - - + \ No newline at end of file diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index d46f79c9d..ae36d1b20 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -1,5 +1,6 @@ --- title: Testing +description: This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you... lang: en-US --- @@ -7,10 +8,9 @@ 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 tutorials and guides to help you understand and work with these topics. +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. - - + \ No newline at end of file diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index b942d205e..90261922e 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -1,5 +1,6 @@ --- 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... lang: en-US --- @@ -7,12 +8,10 @@ import { Card, Cards } from 'nextra/components' # Contribute -This section provides information on contributing to Optimism docs, contributing to the OP Stack, and the docs style guide. Users will find tutorials, overviews, and guides to help them understand and work with these topics. +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. - - + - - - + + \ No newline at end of file diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index a8872f645..8bd4daaa8 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -1,5 +1,6 @@ --- title: Resources +description: This section provides information on . You'll find concept to help you understand and work with these topics. lang: en-US --- @@ -7,8 +8,8 @@ import { Card, Cards } from 'nextra/components' # Resources -This section provides information on various resources related to the OP Stack ecosystem. It includes concepts to help users understand and work with these topics. +This section provides information on . You'll find concept to help you understand and work with these topics. - + \ No newline at end of file diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx index 6fba143cd..71031d603 100644 --- a/pages/stack/operators.mdx +++ b/pages/stack/operators.mdx @@ -1,5 +1,6 @@ --- title: Operators +description: This section provides information on . You'll find guide to help you understand and work with these topics. lang: en-US --- @@ -11,4 +12,4 @@ This section provides information on . You'll find guide to help you understand - + \ No newline at end of file diff --git a/pages/stack/operators/features.mdx b/pages/stack/operators/features.mdx index 0e3865182..3e49e3376 100644 --- a/pages/stack/operators/features.mdx +++ b/pages/stack/operators/features.mdx @@ -1,6 +1,9 @@ --- 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' diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx index ace2c58a4..789d00f3a 100644 --- a/pages/stack/protocol.mdx +++ b/pages/stack/protocol.mdx @@ -1,5 +1,6 @@ --- title: Protocol +description: This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, guide... lang: en-US --- @@ -7,18 +8,13 @@ import { Card, Cards } from 'nextra/components' # Protocol -This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, reference, guide to help you understand and work with these topics. +This section provides information on derivation pipeline, fault proofs, features, interop, sequencer outages and rollup. You'll find overview, guide to help you understand and work with these topics. - - - - - - + \ No newline at end of file diff --git a/pages/stack/protocol/fault-proofs.mdx b/pages/stack/protocol/fault-proofs.mdx index 2d21c4d0c..7875d85aa 100644 --- a/pages/stack/protocol/fault-proofs.mdx +++ b/pages/stack/protocol/fault-proofs.mdx @@ -1,6 +1,9 @@ --- title: Fault Proofs lang: en-US +description: >- + Learn about fault proofs in the Optimism ecosystem. This guide provides + detailed information and resources about fault proofs. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/stack/protocol/features.mdx b/pages/stack/protocol/features.mdx index be264266a..466ac4e35 100644 --- a/pages/stack/protocol/features.mdx +++ b/pages/stack/protocol/features.mdx @@ -1,6 +1,9 @@ --- 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' diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx index bcb1ecf0c..83eb9e66e 100644 --- a/pages/stack/protocol/interop.mdx +++ b/pages/stack/protocol/interop.mdx @@ -1,6 +1,9 @@ --- title: Interop lang: en-US +description: >- + Learn about interop in the Optimism ecosystem. This guide provides detailed + information and resources about interop. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/stack/protocol/rollup.mdx b/pages/stack/protocol/rollup.mdx index 487f5882e..4eadc3973 100644 --- a/pages/stack/protocol/rollup.mdx +++ b/pages/stack/protocol/rollup.mdx @@ -1,6 +1,9 @@ --- title: Rollup lang: en-US +description: >- + Learn about rollup in the Optimism ecosystem. This guide provides detailed + information and resources about rollup. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx index 2ca1e092a..f5ae91bc7 100644 --- a/pages/stack/security.mdx +++ b/pages/stack/security.mdx @@ -1,5 +1,6 @@ --- title: Security +description: This section provides information on op stack security faqs and pausing the bridge. lang: en-US --- @@ -7,10 +8,9 @@ import { Card, Cards } from 'nextra/components' # Security -This section provides information on op stack security faqs and pausing the bridge. +This section provides information on op stack security faqs and pausing the bridge. - - + \ No newline at end of file diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx index 198b3838a..1c00ec866 100644 --- a/pages/stack/transactions.mdx +++ b/pages/stack/transactions.mdx @@ -1,5 +1,6 @@ --- title: Transactions +description: This section provides information on . You'll find reference to help you understand and work with these topics. lang: en-US --- @@ -11,4 +12,4 @@ This section provides information on . You'll find reference to help you underst - + \ No newline at end of file diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index fc123a605..d0fc6b12e 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -1,5 +1,6 @@ import * as fs from 'fs/promises'; import * as path from 'path'; +import matter from 'gray-matter'; const targetFolders: string[] = ['builders', 'chain', 'stack', 'connect']; const rootDir: string = path.join(__dirname, '..', 'pages'); @@ -8,6 +9,13 @@ interface FileInfo { title: string; url: string; content: string; + description?: string; +} + +interface FrontMatter { + title?: string; + description?: string; + lang?: string; } function toTitleCase(str: string): string { @@ -20,6 +28,38 @@ function uniqueArray(arr: string[]): string[] { return arr.filter((value, index, self) => self.indexOf(value) === index); } +function generateDescription(content: string, title: string): string { + // Remove HTML/MDX tags + const cleanContent = content.replace(/<[^>]+>/g, ' ') + .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1') + .replace(/\n+/g, ' ') + .trim(); + + // Find the first paragraph that's not empty and not a title + const paragraphs = cleanContent.split(/\n\n+/); + let firstRelevantParagraph = paragraphs.find(p => + p.trim() && + !p.startsWith('#') && + p.length > 30 && + !p.includes('import') && + !p.includes('export') + ); + + if (!firstRelevantParagraph) { + return `Learn about ${title.toLowerCase()} in the Optimism ecosystem. This guide provides detailed information and resources about ${title.toLowerCase()}.`; + } + + firstRelevantParagraph = firstRelevantParagraph + .replace(/\s+/g, ' ') + .trim(); + + if (firstRelevantParagraph.length > 150) { + firstRelevantParagraph = firstRelevantParagraph.substr(0, 150).split(' ').slice(0, -1).join(' ') + '...'; + } + + return firstRelevantParagraph; +} + function generateOverview(fileInfos: FileInfo[]): string { const topics = fileInfos.map(file => file.title.toLowerCase()); const uniqueTopics = uniqueArray(topics); @@ -45,6 +85,24 @@ function generateOverview(fileInfos: FileInfo[]): string { return overview; } +const processMdxFile = async (filePath: string, fileContent: string): Promise => { + const { data: frontMatter, content } = matter(fileContent); + + // Only generate and add description if it's completely missing + if (!frontMatter.description) { + const title = frontMatter.title || path.basename(filePath, path.extname(filePath)); + frontMatter.description = generateDescription(content, title); + + // Reconstruct the file with the new frontmatter + const updatedContent = matter.stringify(content, frontMatter); + await fs.writeFile(filePath, updatedContent); + console.log(`Added description to ${filePath}`); + return updatedContent; + } + + return fileContent; +}; + const createMdxFile = async (parentFolderPath: string, folderName: string): Promise => { const folderPath = path.join(parentFolderPath, folderName); const files = await fs.readdir(folderPath); @@ -54,25 +112,47 @@ const createMdxFile = async (parentFolderPath: string, folderName: string): Prom ); const title = toTitleCase(folderName); - const fileInfos: FileInfo[] = []; for (const file of mdFiles) { const filePath = path.join(folderPath, file); - const fileContent = await fs.readFile(filePath, 'utf-8'); - let fileTitle = fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); + let fileContent = await fs.readFile(filePath, 'utf-8'); + + // Process individual files to add missing descriptions + fileContent = await processMdxFile(filePath, fileContent); + + const { data: frontMatter } = matter(fileContent); + let fileTitle = frontMatter.title || fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); fileTitle = toTitleCase(fileTitle); const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); if (!fileInfos.some(info => info.url === relativeUrl)) { - fileInfos.push({ title: fileTitle, url: relativeUrl, content: fileContent }); + fileInfos.push({ + title: fileTitle, + url: relativeUrl, + content: fileContent, + description: frontMatter.description + }); } } const overview = generateOverview(fileInfos); + const mdxFileName = `${folderName}.mdx`; + const mdxFilePath = path.join(parentFolderPath, mdxFileName); + + // Check if the overview file already exists and has a description + let existingDescription: string | undefined; + try { + const existingContent = await fs.readFile(mdxFilePath, 'utf-8'); + const { data: existingFrontMatter } = matter(existingContent); + existingDescription = existingFrontMatter.description; + } catch (error) { + // File doesn't exist yet + } let content = `--- title: ${title} +${existingDescription ? `description: ${existingDescription}` : `description: ${generateDescription(overview, title)}`} lang: en-US --- @@ -91,21 +171,13 @@ ${overview} content += ''; - const mdxFileName = `${folderName}.mdx`; - const mdxFilePath = path.join(parentFolderPath, mdxFileName); - - // Check if the file already exists and has the same content - try { - const existingContent = await fs.readFile(mdxFilePath, 'utf-8'); - if (existingContent.trim() === content.trim()) { - console.log(`${mdxFileName} in ${parentFolderPath} is up to date. Skipping.`); - return; - } - } catch (error) { + // Only write if the file doesn't exist or if it exists but has no description + if (!existingDescription) { + await fs.writeFile(mdxFilePath, content); + console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`); + } else { + console.log(`Skipping ${mdxFileName} in ${parentFolderPath} - existing description preserved`); } - - await fs.writeFile(mdxFilePath, content); - console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`); }; const processFolder = async (folderPath: string): Promise => { From 5d10446b998d4138874741e92e6f1415c4972bcc Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 12:54:07 +0100 Subject: [PATCH 12/19] fix lint issues --- pages/builders/app-developers/tools/supersim.mdx | 2 ++ pages/builders/app-developers/transactions/fees.mdx | 2 ++ pages/builders/app-developers/tutorials.mdx | 1 + pages/builders/cex-wallet-developers.mdx | 3 ++- pages/builders/node-operators.mdx | 9 ++++++++- pages/builders/notices.mdx | 4 +++- pages/builders/tools.mdx | 7 ++++++- pages/builders/tools/connect/networks.mdx | 2 ++ pages/chain/identity.mdx | 9 ++++++++- pages/chain/security.mdx | 6 ++++-- pages/chain/testing.mdx | 3 ++- pages/connect/contribute.mdx | 4 +++- pages/connect/resources.mdx | 2 +- pages/stack/operators.mdx | 2 +- pages/stack/protocol.mdx | 7 ++++++- pages/stack/security.mdx | 5 +++-- pages/stack/transactions.mdx | 2 +- words.txt | 1 - 18 files changed, 55 insertions(+), 16 deletions(-) diff --git a/pages/builders/app-developers/tools/supersim.mdx b/pages/builders/app-developers/tools/supersim.mdx index e76629fc2..afcfb204f 100644 --- a/pages/builders/app-developers/tools/supersim.mdx +++ b/pages/builders/app-developers/tools/supersim.mdx @@ -1,4 +1,6 @@ --- +title: Supersim +lang: en-US description: >- Learn about supersim in the Optimism ecosystem. This guide provides detailed information and resources about supersim. diff --git a/pages/builders/app-developers/transactions/fees.mdx b/pages/builders/app-developers/transactions/fees.mdx index 2808ca1f6..cc3b2e6f3 100644 --- a/pages/builders/app-developers/transactions/fees.mdx +++ b/pages/builders/app-developers/transactions/fees.mdx @@ -1,4 +1,6 @@ --- +title: TransactionFees +lang: en-US description: >- Learn about fees in the Optimism ecosystem. This guide provides detailed information and resources about fees. diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx index 2eca7c7ff..807686a51 100644 --- a/pages/builders/app-developers/tutorials.mdx +++ b/pages/builders/app-developers/tutorials.mdx @@ -5,6 +5,7 @@ description: A collection of tutorials for app developers building on OP Stack, --- 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. diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index a5b8c0a56..0debde339 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -12,5 +12,6 @@ This section provides information on supporting op mainnet in your exchange and + - \ No newline at end of file + diff --git a/pages/builders/node-operators.mdx b/pages/builders/node-operators.mdx index e9535def2..bd2ffdeba 100644 --- a/pages/builders/node-operators.mdx +++ b/pages/builders/node-operators.mdx @@ -12,11 +12,18 @@ This section provides information on node architecture, configuration, json rpc + + + + + + + - \ No newline at end of file + diff --git a/pages/builders/notices.mdx b/pages/builders/notices.mdx index 2f9534e95..81a3ecb0a 100644 --- a/pages/builders/notices.mdx +++ b/pages/builders/notices.mdx @@ -12,6 +12,8 @@ This section provides information on preparing for fault proofs breaking changes + + - \ No newline at end of file + diff --git a/pages/builders/tools.mdx b/pages/builders/tools.mdx index 3bebb9d3b..4541d4cd8 100644 --- a/pages/builders/tools.mdx +++ b/pages/builders/tools.mdx @@ -12,9 +12,14 @@ This section provides information on build, connect, fjord fee parameter calcula + + + + + - \ No newline at end of file + diff --git a/pages/builders/tools/connect/networks.mdx b/pages/builders/tools/connect/networks.mdx index f43ede8e7..7440c93ec 100644 --- a/pages/builders/tools/connect/networks.mdx +++ b/pages/builders/tools/connect/networks.mdx @@ -1,4 +1,6 @@ --- +title: OPNetworks +lang: en-US description: >- Learn about networks in the Optimism ecosystem. This guide provides detailed information and resources about networks. diff --git a/pages/chain/identity.mdx b/pages/chain/identity.mdx index faff79b4b..2f9a23ac9 100644 --- a/pages/chain/identity.mdx +++ b/pages/chain/identity.mdx @@ -12,11 +12,18 @@ This section provides information on about attestations, attestation apps, contr + + + + + + + - \ No newline at end of file + diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index 7b4a79f04..2a18f2ac2 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -8,10 +8,12 @@ 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. +This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. + + - \ No newline at end of file + diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index ae36d1b20..6fa7d9361 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -12,5 +12,6 @@ This section provides information on running a local development environment and + - \ No newline at end of file + diff --git a/pages/connect/contribute.mdx b/pages/connect/contribute.mdx index 90261922e..8ef9eb298 100644 --- a/pages/connect/contribute.mdx +++ b/pages/connect/contribute.mdx @@ -12,6 +12,8 @@ This section provides information on ways to contribute to optimism docs, contri + + - \ No newline at end of file + diff --git a/pages/connect/resources.mdx b/pages/connect/resources.mdx index 8bd4daaa8..80b083fe7 100644 --- a/pages/connect/resources.mdx +++ b/pages/connect/resources.mdx @@ -12,4 +12,4 @@ This section provides information on . You'll find concept to help you understan - \ No newline at end of file + diff --git a/pages/stack/operators.mdx b/pages/stack/operators.mdx index 71031d603..01c05b33c 100644 --- a/pages/stack/operators.mdx +++ b/pages/stack/operators.mdx @@ -12,4 +12,4 @@ This section provides information on . You'll find guide to help you understand - \ No newline at end of file + diff --git a/pages/stack/protocol.mdx b/pages/stack/protocol.mdx index 789d00f3a..05bb23994 100644 --- a/pages/stack/protocol.mdx +++ b/pages/stack/protocol.mdx @@ -12,9 +12,14 @@ This section provides information on derivation pipeline, fault proofs, features + + + + + - \ No newline at end of file + diff --git a/pages/stack/security.mdx b/pages/stack/security.mdx index f5ae91bc7..11e8a0d7c 100644 --- a/pages/stack/security.mdx +++ b/pages/stack/security.mdx @@ -8,9 +8,10 @@ import { Card, Cards } from 'nextra/components' # Security -This section provides information on op stack security faqs and pausing the bridge. +This section provides information on op stack security faqs and pausing the bridge. + - \ No newline at end of file + diff --git a/pages/stack/transactions.mdx b/pages/stack/transactions.mdx index 1c00ec866..929eea7c7 100644 --- a/pages/stack/transactions.mdx +++ b/pages/stack/transactions.mdx @@ -12,4 +12,4 @@ This section provides information on . You'll find reference to help you underst - \ No newline at end of file + diff --git a/words.txt b/words.txt index f0363cc63..5d392acea 100644 --- a/words.txt +++ b/words.txt @@ -320,7 +320,6 @@ Schnorr secp SELFDESTRUCT Sendrawtransactionconditional -sendrawtransactionconditional seqnr SEQUENCERHTTP sequencerhttp From 1a635fa007814ba3627ee5637f87d09bfef410d6 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 13:34:50 +0100 Subject: [PATCH 13/19] updated lyche --- lychee.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lychee.toml b/lychee.toml index b5131db61..60e8be5a2 100644 --- 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 From 83d183b5ed7d6eb9c9119b797728a00358e92f45 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 14:26:06 +0100 Subject: [PATCH 14/19] use OP stack instead of OP mainnet --- pages/builders/app-developers/contracts.mdx | 4 +- .../builders/app-developers/transactions.mdx | 4 +- pages/builders/cex-wallet-developers.mdx | 4 +- pages/chain/security.mdx | 4 +- pages/chain/testing.mdx | 4 +- utils/create-breadcrumbs.ts | 209 ++++-------------- 6 files changed, 60 insertions(+), 169 deletions(-) diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index 06e1b874a..7ddac908f 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -1,7 +1,9 @@ --- title: Contracts lang: en-US -description: Information on Solidity compatibility, contract optimization, and system contracts for OP Mainnet. +description: >- + Information on Solidity compatibility, contract optimization, and system + contracts for OP Stack. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/app-developers/transactions.mdx b/pages/builders/app-developers/transactions.mdx index 847b05e02..e845de2d1 100644 --- a/pages/builders/app-developers/transactions.mdx +++ b/pages/builders/app-developers/transactions.mdx @@ -1,7 +1,9 @@ --- title: Transactions lang: en-US -description: Guide to understanding and working with transactions on OP Mainnet, including fee estimation, gas parameters, and troubleshooting. +description: >- + Guide to understanding and working with transactions on OP Stack, including + fee estimation, gas parameters, and troubleshooting. --- import { Card, Cards } from 'nextra/components' diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 0debde339..976d18070 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -1,6 +1,8 @@ --- title: Cex Wallet Developers -description: 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... +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 --- diff --git a/pages/chain/security.mdx b/pages/chain/security.mdx index 2a18f2ac2..b1a09682c 100644 --- a/pages/chain/security.mdx +++ b/pages/chain/security.mdx @@ -1,6 +1,8 @@ --- title: Security -description: This section provides information on op mainnet security model, privileged roles in op mainnet and security policy and bug bounty program. +description: >- + This section provides information on OP Stack security model, privileged roles + in OP Stack and security policy and bug bounty program. lang: en-US --- diff --git a/pages/chain/testing.mdx b/pages/chain/testing.mdx index 6fa7d9361..923766e11 100644 --- a/pages/chain/testing.mdx +++ b/pages/chain/testing.mdx @@ -1,6 +1,8 @@ --- title: Testing -description: This section provides information on running a local development environment and testing apps for op mainnet. You'll find tutorial, guide to help you... +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... lang: en-US --- diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index d0fc6b12e..45d73a33b 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -8,175 +8,41 @@ const rootDir: string = path.join(__dirname, '..', 'pages'); interface FileInfo { title: string; url: string; - content: string; - description?: string; } -interface FrontMatter { - title?: string; - description?: string; - lang?: string; -} - -function toTitleCase(str: string): string { - return str.split('-').map(word => - word.charAt(0).toUpperCase() + word.slice(1).toLowerCase() - ).join(' '); -} - -function uniqueArray(arr: string[]): string[] { - return arr.filter((value, index, self) => self.indexOf(value) === index); -} - -function generateDescription(content: string, title: string): string { - // Remove HTML/MDX tags - const cleanContent = content.replace(/<[^>]+>/g, ' ') - .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1') - .replace(/\n+/g, ' ') - .trim(); - - // Find the first paragraph that's not empty and not a title - const paragraphs = cleanContent.split(/\n\n+/); - let firstRelevantParagraph = paragraphs.find(p => - p.trim() && - !p.startsWith('#') && - p.length > 30 && - !p.includes('import') && - !p.includes('export') - ); - - if (!firstRelevantParagraph) { - return `Learn about ${title.toLowerCase()} in the Optimism ecosystem. This guide provides detailed information and resources about ${title.toLowerCase()}.`; - } - - firstRelevantParagraph = firstRelevantParagraph - .replace(/\s+/g, ' ') - .trim(); - - if (firstRelevantParagraph.length > 150) { - firstRelevantParagraph = firstRelevantParagraph.substr(0, 150).split(' ').slice(0, -1).join(' ') + '...'; +function updateOPTerminology(description: string): string { + // Skip if already contains "OP Stack" + if (description.includes('OP Stack')) { + return description; } - - return firstRelevantParagraph; -} - -function generateOverview(fileInfos: FileInfo[]): string { - const topics = fileInfos.map(file => file.title.toLowerCase()); - const uniqueTopics = uniqueArray(topics); - let overview = `This section provides information on ${uniqueTopics.slice(0, -1).join(', ')}`; - if (uniqueTopics.length > 1) { - overview += ` and ${uniqueTopics[uniqueTopics.length - 1]}`; - } - overview += '. '; - - const keywordRegex = /\b(guide|tutorial|overview|introduction|tool|concept|api|reference)\b/i; - const keywords = uniqueArray( - fileInfos.flatMap(file => { - const matches = file.content.match(keywordRegex); - return matches ? matches.map(keyword => keyword.toLowerCase()) : []; - }) - ); - - if (keywords.length > 0) { - overview += `You'll find ${keywords.join(', ')} to help you understand and work with these topics.`; - } - - return overview; + // Replace variations of "OP Mainnet" with "OP Stack" + return description + .replace(/\bOP Mainnet\b/gi, 'OP Stack') + .replace(/\bOptimism Mainnet\b/gi, 'OP Stack') + .replace(/\bOptimism mainnet\b/gi, 'OP Stack'); } -const processMdxFile = async (filePath: string, fileContent: string): Promise => { - const { data: frontMatter, content } = matter(fileContent); - - // Only generate and add description if it's completely missing - if (!frontMatter.description) { - const title = frontMatter.title || path.basename(filePath, path.extname(filePath)); - frontMatter.description = generateDescription(content, title); - - // Reconstruct the file with the new frontmatter - const updatedContent = matter.stringify(content, frontMatter); - await fs.writeFile(filePath, updatedContent); - console.log(`Added description to ${filePath}`); - return updatedContent; - } - - return fileContent; -}; - -const createMdxFile = async (parentFolderPath: string, folderName: string): Promise => { - const folderPath = path.join(parentFolderPath, folderName); - const files = await fs.readdir(folderPath); - const mdFiles = files.filter(file => - (file.endsWith('.md') || file.endsWith('.mdx')) && - !file.startsWith('_') - ); - - const title = toTitleCase(folderName); - const fileInfos: FileInfo[] = []; +const updateBreadcrumbFile = async (filePath: string): Promise => { + try { + const content = await fs.readFile(filePath, 'utf-8'); + const { data: frontMatter, content: fileContent } = matter(content); - for (const file of mdFiles) { - const filePath = path.join(folderPath, file); - let fileContent = await fs.readFile(filePath, 'utf-8'); - - // Process individual files to add missing descriptions - fileContent = await processMdxFile(filePath, fileContent); - - const { data: frontMatter } = matter(fileContent); - let fileTitle = frontMatter.title || fileContent.match(/^#\s+(.+)/m)?.[1] || path.basename(file, path.extname(file)); - fileTitle = toTitleCase(fileTitle); - const relativeUrl = `/${path.relative(rootDir, folderPath)}/${path.basename(file, path.extname(file))}`.replace(/\\/g, '/'); - - if (!fileInfos.some(info => info.url === relativeUrl)) { - fileInfos.push({ - title: fileTitle, - url: relativeUrl, - content: fileContent, - description: frontMatter.description - }); + // Only process if there's a description that contains OP Mainnet but not OP Stack + if (frontMatter.description && + frontMatter.description.match(/\bOP Mainnet\b|\bOptimism Mainnet\b/gi) && + !frontMatter.description.includes('OP Stack')) { + + // Update the description + frontMatter.description = updateOPTerminology(frontMatter.description); + + // Write back to file + const updatedContent = matter.stringify(fileContent, frontMatter); + await fs.writeFile(filePath, updatedContent); + console.log(`Updated description in breadcrumb file: ${filePath}`); } - } - - const overview = generateOverview(fileInfos); - const mdxFileName = `${folderName}.mdx`; - const mdxFilePath = path.join(parentFolderPath, mdxFileName); - - // Check if the overview file already exists and has a description - let existingDescription: string | undefined; - try { - const existingContent = await fs.readFile(mdxFilePath, 'utf-8'); - const { data: existingFrontMatter } = matter(existingContent); - existingDescription = existingFrontMatter.description; } catch (error) { - // File doesn't exist yet - } - - let content = `--- -title: ${title} -${existingDescription ? `description: ${existingDescription}` : `description: ${generateDescription(overview, title)}`} -lang: en-US ---- - -import { Card, Cards } from 'nextra/components' - -# ${title} - -${overview} - - -`; - - fileInfos.forEach(({ title, url }) => { - content += ` \n`; - }); - - content += ''; - - // Only write if the file doesn't exist or if it exists but has no description - if (!existingDescription) { - await fs.writeFile(mdxFilePath, content); - console.log(`Created/Updated ${mdxFileName} in ${parentFolderPath}`); - } else { - console.log(`Skipping ${mdxFileName} in ${parentFolderPath} - existing description preserved`); + console.error(`Error processing file ${filePath}:`, error); } }; @@ -189,7 +55,16 @@ const processFolder = async (folderPath: string): Promise => { const stats = await fs.stat(filePath); if (stats.isDirectory()) { - await createMdxFile(folderPath, file); + // Process breadcrumb file for this directory if it exists + const breadcrumbFile = path.join(folderPath, `${file}.mdx`); + try { + await fs.access(breadcrumbFile); + await updateBreadcrumbFile(breadcrumbFile); + } catch (error) { + // Breadcrumb file doesn't exist, skip + } + + // Continue processing subdirectories await processFolder(filePath); } } @@ -199,12 +74,18 @@ const processFolder = async (folderPath: string): Promise => { }; const main = async (): Promise => { + console.log('Starting breadcrumb description update process...'); + console.log('Root directory:', rootDir); + for (const folder of targetFolders) { const folderPath = path.join(rootDir, folder); await processFolder(folderPath); } -}; -main().catch(console.error); + console.log('Finished updating breadcrumb descriptions.'); +}; -console.log('Root directory:', rootDir); \ No newline at end of file +main().catch(error => { + console.error('Error in main process:', error); + process.exit(1); +}); \ No newline at end of file From 0a42b3630f714f4527936a860a2b2a73d0a63320 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 14:27:03 +0100 Subject: [PATCH 15/19] clean the code --- utils/create-breadcrumbs.ts | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/utils/create-breadcrumbs.ts b/utils/create-breadcrumbs.ts index 45d73a33b..7bfab9804 100644 --- a/utils/create-breadcrumbs.ts +++ b/utils/create-breadcrumbs.ts @@ -11,7 +11,7 @@ interface FileInfo { } function updateOPTerminology(description: string): string { - // Skip if already contains "OP Stack" + if (description.includes('OP Stack')) { return description; } @@ -28,15 +28,13 @@ const updateBreadcrumbFile = async (filePath: string): Promise => { const content = await fs.readFile(filePath, 'utf-8'); const { data: frontMatter, content: fileContent } = matter(content); - // Only process if there's a description that contains OP Mainnet but not OP Stack if (frontMatter.description && frontMatter.description.match(/\bOP Mainnet\b|\bOptimism Mainnet\b/gi) && !frontMatter.description.includes('OP Stack')) { - - // Update the description + frontMatter.description = updateOPTerminology(frontMatter.description); - // Write back to file + const updatedContent = matter.stringify(fileContent, frontMatter); await fs.writeFile(filePath, updatedContent); console.log(`Updated description in breadcrumb file: ${filePath}`); @@ -55,16 +53,16 @@ const processFolder = async (folderPath: string): Promise => { const stats = await fs.stat(filePath); if (stats.isDirectory()) { - // Process breadcrumb file for this directory if it exists + const breadcrumbFile = path.join(folderPath, `${file}.mdx`); try { await fs.access(breadcrumbFile); await updateBreadcrumbFile(breadcrumbFile); } catch (error) { - // Breadcrumb file doesn't exist, skip + } - // Continue processing subdirectories + await processFolder(filePath); } } From 91013c7c0c09e9cb31c93eea4b7990b1f7f1a5d5 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 14:32:16 +0100 Subject: [PATCH 16/19] update text --- pages/builders/cex-wallet-developers.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/builders/cex-wallet-developers.mdx b/pages/builders/cex-wallet-developers.mdx index 976d18070..0ac230932 100644 --- a/pages/builders/cex-wallet-developers.mdx +++ b/pages/builders/cex-wallet-developers.mdx @@ -1,5 +1,5 @@ --- -title: Cex Wallet Developers +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... @@ -8,7 +8,7 @@ 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. From d766fbf010f67dfd8683d76be116fa1bc06ecaf0 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 14:38:56 +0100 Subject: [PATCH 17/19] fix lint issues --- pages/builders.mdx | 2 +- pages/builders/node-operators/configuration.mdx | 2 +- pages/stack/protocol/interop.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/builders.mdx b/pages/builders.mdx index 810cb0fcd..ab69e59b6 100644 --- a/pages/builders.mdx +++ b/pages/builders.mdx @@ -8,7 +8,7 @@ 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. +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. diff --git a/pages/builders/node-operators/configuration.mdx b/pages/builders/node-operators/configuration.mdx index de45fff09..da2c8f8a8 100644 --- a/pages/builders/node-operators/configuration.mdx +++ b/pages/builders/node-operators/configuration.mdx @@ -10,7 +10,7 @@ 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. +This section provides information on node base configuration, consensus layer configuration options (OP Node), and execution layer configuration options (OP Geth). You'll find information to help you understand and work with these topics. diff --git a/pages/stack/protocol/interop.mdx b/pages/stack/protocol/interop.mdx index 83eb9e66e..499809656 100644 --- a/pages/stack/protocol/interop.mdx +++ b/pages/stack/protocol/interop.mdx @@ -10,7 +10,7 @@ import { Card, Cards } from 'nextra/components' # Interop -This section provides information on anatomy of a cross chain message, interoperability explainer and supersim multichain development environment. You'll find overview, guide, tool to help you understand and work with these topics. +This section provides information on the anatomy of a cross-chain message, an interoperability explainer, and the Supersim multichain development environment. You'll find an overview, guide, and tools to help you understand and work with these topics. From 1f7af3295009e1e9bd83013d98406ab85f9dc6b4 Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 24 Oct 2024 14:55:39 +0100 Subject: [PATCH 18/19] wrote docs for teh script --- notes/breadcrumbs.md | 36 ++++++++++++++++++++++++++++++++++++ words.txt | 2 -- 2 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 notes/breadcrumbs.md diff --git a/notes/breadcrumbs.md b/notes/breadcrumbs.md new file mode 100644 index 000000000..e30512e7f --- /dev/null +++ b/notes/breadcrumbs.md @@ -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 \ No newline at end of file diff --git a/words.txt b/words.txt index 1399efb94..c4cf76483 100644 --- a/words.txt +++ b/words.txt @@ -204,8 +204,6 @@ MTHI MTLO MULT multiaddr -breadcrumbs -Multichain multichain multiclient multisigs From c502be93ed461a89f5dbe69ca3b864f9be80263e Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Fri, 25 Oct 2024 09:38:03 +0100 Subject: [PATCH 19/19] updated content --- pages/builders/app-developers/contracts.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/builders/app-developers/contracts.mdx b/pages/builders/app-developers/contracts.mdx index 7ddac908f..6c01b91e2 100644 --- a/pages/builders/app-developers/contracts.mdx +++ b/pages/builders/app-developers/contracts.mdx @@ -10,12 +10,12 @@ 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 guides and tutorials to help you understand and work with these topics. +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. - + - +