Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"fix-redirects": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/fix-redirects.ts",
"link-checker": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/link-checker.ts",
"metadata-batch-cli": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-batch-cli.ts",
"metadata-batch-cli:dry": "pnpm metadata-batch-cli --dry-run",
"metadata-batch-cli:dry": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-batch-cli.ts --dry-run",
"metadata-batch-cli:verbose": "pnpm metadata-batch-cli --verbose",
"validate-metadata": "CHANGED_FILES=$(git diff --name-only HEAD) pnpm metadata-batch-cli:dry",
"validate-pr-metadata": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-manager.ts --pr",
Expand Down
15 changes: 14 additions & 1 deletion pages/connect/contribute.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
---
title: Contribute
description: Documentation covering Docs Contribute, Stack Contribute, Style Guide in the Contribute section of the OP Stack ecosystem.
description: >-
Documentation covering Docs Contribute, Stack Contribute, Style Guide in the
Contribute section of the OP Stack ecosystem.
lang: en-US
content_type: guide
topic: contribute
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- security-council
- blockspace-charters
is_imported_content: 'false'
---

import { Card, Cards } from 'nextra/components'
Expand Down
16 changes: 13 additions & 3 deletions pages/connect/contribute/docs-contribute.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Ways to contribute to Optimism Docs
lang: en-US
title: Contribute to Optimism Docs
description: Learn about the different ways you can contribute to Optimism Docs.
lang: en-US
content_type: guide
topic: docs-contribute
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- security-council
- protocol
is_imported_content: 'false'
---

import { Callout } from 'nextra/components'
Expand All @@ -17,7 +28,6 @@ Optimism Docs (docs.optimism.io) is an open-source project, and we welcome your

## Ways to contribute

* [Work on a good first issue](https://github.com/ethereum-optimism/docs/labels/good%20first%20issue): make the greatest and most immediate impact with a quick-start or tutorial. These special issues are clearly labeled for new contributors to Optimism.
* [Edit existing content](#how-to-work-on-docsoptimismio): make tweaks to existing content using the ✏️ **Edit this page on GitHub** or ❤️ **Share general feedback** links on the right-side of any page.
* [Add or update an FAQ item](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=documentation%2Cfaq%2Ccommunity-request\&projects=\&template=suggest_faq_item.yaml\&title=Suggest+an+FAQ+item):
add a new FAQ (question+answer set) to an [existing page](/stack/security/faq-sec-model), create a new FAQ page, or update an existing FAQ question/answer set.
Expand Down
13 changes: 12 additions & 1 deletion pages/connect/contribute/stack-contribute.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Contribute to the OP Stack
lang: en-US
description: Learn different ways you can contribute to the OP Stack.
lang: en-US
content_type: guide
topic: stack-contribute
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- security-council
- protocol
is_imported_content: 'false'
---

import { Callout } from 'nextra/components'
Expand Down
17 changes: 15 additions & 2 deletions pages/connect/contribute/style-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
---
title: Optimism Docs style guide
title: Docs style guide
description: >-
This guide explains how to write technical content for Optimism Docs using a
consistent voice, tone, and style.
lang: en-US
description: This guide explains how to write technical content for Optimism Docs using a consistent voice, tone, and style.
content_type: guide
topic: style-guide
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- security-council
- protocol
is_imported_content: 'false'
---

import { Callout } from 'nextra/components'
Expand Down
15 changes: 14 additions & 1 deletion pages/connect/resources.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
---
title: Resources
description: Documentation covering Glossary in the Resources section of the OP Stack ecosystem.
description: >-
Documentation covering Glossary in the Resources section of the OP Stack
ecosystem.
lang: en-US
content_type: guide
topic: resources
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- security-council
- blockspace-charters
is_imported_content: 'false'
---

import { Card, Cards } from 'nextra/components'
Expand Down
18 changes: 16 additions & 2 deletions pages/connect/resources/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
---
title: Glossary
title: glossary
description: >-
Learn the meaning of important terminology used throughout the Optimism
Developer Documentation.
lang: en-US
description: Learn the meaning of important terminology used throughout the Optimism Developer Documentation.
content_type: reference
topic: glossary
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
- governance-participant
categories:
- security-council
- protocol
is_imported_content: 'false'
---

import { Callout } from 'nextra/components'
Expand Down
14 changes: 12 additions & 2 deletions pages/get-started/interop.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
---
title: Getting started with the OP Stack
title: Superchain Interoperability explainer
description: Learn the basics of interoperability.
lang: en-US
description: Learn the basics of OP Stack development.
content_type: guide
topic: interop
personas:
- app-developer
- protocol-developer
categories:
- protocol
- hardhat
- foundry
is_imported_content: 'true'
---

import InteropExplainer from '@/pages/stack/interop/explainer.mdx'
Expand Down
14 changes: 13 additions & 1 deletion pages/get-started/op-stack.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
---
title: Getting started with the OP Stack
lang: en-US
description: Learn the basics of OP Stack development.
lang: en-US
content_type: guide
topic: op-stack
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- protocol
- hardhat
- foundry
is_imported_content: 'true'
---

import StackExplainer from '@/pages/stack/getting-started.mdx'
Expand Down
14 changes: 13 additions & 1 deletion pages/get-started/superchain.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
---
title: Superchain explainer
description: 'Learn about Optimism Superchain components, features, and roadmap.'
lang: en-US
description: Learn about Optimism Superchain components, features, and roadmap.
content_type: guide
topic: superchain
personas:
- app-developer
- protocol-developer
- chain-operator
- node-operator
categories:
- protocol
- hardhat
- foundry
is_imported_content: 'true'
---

import SuperchainExplainer from '@/pages/superchain/superchain-explainer.mdx'
Expand Down
15 changes: 13 additions & 2 deletions pages/notices/custom-gas-tokens-deprecation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Deprecation of the Custom Gas Tokens
title: Preparing for custom gas tokens deprecation
description: >-
This page outlines the details of the Custom Gas Tokens deprecation and points
towards alternatives
lang: en-US
description: This page outlines the details of the Custom Gas Tokens deprecation and points towards alternatives
content_type: guide
topic: custom-gas-tokens-deprecation
personas:
- app-developer
- chain-operator
categories:
- security
- automated-pause
is_imported_content: 'false'
---

## Deprecation of Custom Gas Tokens
Expand Down
15 changes: 13 additions & 2 deletions pages/notices/holocene-changes.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Preparing for Holocene Breaking Changes
lang: en-US
title: Preparing for Holocene breaking changes
description: Learn how to prepare for Holocene upgrade breaking changes.
lang: en-US
content_type: guide
topic: holocene-changes
personas:
- chain-operator
- node-operator
categories:
- security
- automated-pause
- protocol
- infrastructure
is_imported_content: 'false'
---

import { Steps, Callout } from 'nextra/components'
Expand Down
15 changes: 13 additions & 2 deletions pages/notices/pectra-changes.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Preparing for Pectra Breaking Changes
lang: en-US
title: Preparing for Pectra breaking changes
description: Learn how to prepare for Pectra upgrade breaking changes.
lang: en-US
content_type: guide
topic: pectra-changes
personas:
- chain-operator
- node-operator
categories:
- security
- automated-pause
- protocol
- infrastructure
is_imported_content: 'false'
---

import { Steps, Callout } from 'nextra/components'
Expand Down
15 changes: 13 additions & 2 deletions pages/notices/sdk-deprecation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Deprecation of the Optimism SDK
title: Preparing for Optimism SDK deprecation
description: >-
This page outlines the details of the Optimism SDK deprecation and guides
developers to migrate to using `viem` library.
lang: en-US
description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem` library.
content_type: guide
topic: sdk-deprecation
personas:
- app-developer
categories:
- protocol
- ethers
- viem
is_imported_content: 'false'
---

## Preparing for Optimism SDK deprecation
Expand Down
Loading