Skip to content

Commit f02c327

Browse files
cpengillycpengilly
authored
Merge pull request #1441 from ethereum-optimism/metatag-notices-connect
metadata-3directories
2 parents 931cf9d + b56bf31 commit f02c327

18 files changed

+326
-149
lines changed

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"fix-redirects": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/fix-redirects.ts",
1515
"link-checker": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/link-checker.ts",
1616
"metadata-batch-cli": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-batch-cli.ts",
17-
"metadata-batch-cli:dry": "pnpm metadata-batch-cli --dry-run",
17+
"metadata-batch-cli:dry": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-batch-cli.ts --dry-run",
1818
"metadata-batch-cli:verbose": "pnpm metadata-batch-cli --verbose",
1919
"validate-metadata": "CHANGED_FILES=$(git diff --name-only HEAD) pnpm metadata-batch-cli:dry",
2020
"validate-pr-metadata": "NODE_NO_WARNINGS=1 node --loader ts-node/esm utils/metadata-manager.ts --pr",

‎pages/connect/contribute.mdx

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
---
22
title: Contribute
3-
description: Documentation covering Docs Contribute, Stack Contribute, Style Guide in the Contribute section of the OP Stack ecosystem.
3+
description: >-
4+
Documentation covering Docs Contribute, Stack Contribute, Style Guide in the
5+
Contribute section of the OP Stack ecosystem.
46
lang: en-US
7+
content_type: guide
8+
topic: contribute
9+
personas:
10+
- app-developer
11+
- protocol-developer
12+
- chain-operator
13+
- node-operator
14+
categories:
15+
- security-council
16+
- blockspace-charters
17+
is_imported_content: 'false'
518
---
619

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

‎pages/connect/contribute/docs-contribute.mdx

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
2-
title: Ways to contribute to Optimism Docs
3-
lang: en-US
2+
title: Contribute to Optimism Docs
43
description: Learn about the different ways you can contribute to Optimism Docs.
4+
lang: en-US
5+
content_type: guide
6+
topic: docs-contribute
7+
personas:
8+
- app-developer
9+
- protocol-developer
10+
- chain-operator
11+
- node-operator
12+
categories:
13+
- security-council
14+
- protocol
15+
is_imported_content: 'false'
516
---
617

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

1829
## Ways to contribute
1930

20-
* [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.
2131
* [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.
2232
* [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):
2333
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.

‎pages/connect/contribute/stack-contribute.mdx

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
22
title: Contribute to the OP Stack
3-
lang: en-US
43
description: Learn different ways you can contribute to the OP Stack.
4+
lang: en-US
5+
content_type: guide
6+
topic: stack-contribute
7+
personas:
8+
- app-developer
9+
- protocol-developer
10+
- chain-operator
11+
- node-operator
12+
categories:
13+
- security-council
14+
- protocol
15+
is_imported_content: 'false'
516
---
617

718
import { Callout } from 'nextra/components'

‎pages/connect/contribute/style-guide.mdx

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
---
2-
title: Optimism Docs style guide
2+
title: Docs style guide
3+
description: >-
4+
This guide explains how to write technical content for Optimism Docs using a
5+
consistent voice, tone, and style.
36
lang: en-US
4-
description: This guide explains how to write technical content for Optimism Docs using a consistent voice, tone, and style.
7+
content_type: guide
8+
topic: style-guide
9+
personas:
10+
- app-developer
11+
- protocol-developer
12+
- chain-operator
13+
- node-operator
14+
categories:
15+
- security-council
16+
- protocol
17+
is_imported_content: 'false'
518
---
619

720
import { Callout } from 'nextra/components'

‎pages/connect/resources.mdx

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
---
22
title: Resources
3-
description: Documentation covering Glossary in the Resources section of the OP Stack ecosystem.
3+
description: >-
4+
Documentation covering Glossary in the Resources section of the OP Stack
5+
ecosystem.
46
lang: en-US
7+
content_type: guide
8+
topic: resources
9+
personas:
10+
- app-developer
11+
- protocol-developer
12+
- chain-operator
13+
- node-operator
14+
categories:
15+
- security-council
16+
- blockspace-charters
17+
is_imported_content: 'false'
518
---
619

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

‎pages/connect/resources/glossary.mdx

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
---
2-
title: Glossary
2+
title: glossary
3+
description: >-
4+
Learn the meaning of important terminology used throughout the Optimism
5+
Developer Documentation.
36
lang: en-US
4-
description: Learn the meaning of important terminology used throughout the Optimism Developer Documentation.
7+
content_type: reference
8+
topic: glossary
9+
personas:
10+
- app-developer
11+
- protocol-developer
12+
- chain-operator
13+
- node-operator
14+
- governance-participant
15+
categories:
16+
- security-council
17+
- protocol
18+
is_imported_content: 'false'
519
---
620

721
import { Callout } from 'nextra/components'

‎pages/get-started/interop.mdx

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
---
2-
title: Getting started with the OP Stack
2+
title: Superchain Interoperability explainer
3+
description: Learn the basics of interoperability.
34
lang: en-US
4-
description: Learn the basics of OP Stack development.
5+
content_type: guide
6+
topic: interop
7+
personas:
8+
- app-developer
9+
- protocol-developer
10+
categories:
11+
- protocol
12+
- hardhat
13+
- foundry
14+
is_imported_content: 'true'
515
---
616

717
import InteropExplainer from '@/pages/stack/interop/explainer.mdx'

‎pages/get-started/op-stack.mdx

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
---
22
title: Getting started with the OP Stack
3-
lang: en-US
43
description: Learn the basics of OP Stack development.
4+
lang: en-US
5+
content_type: guide
6+
topic: op-stack
7+
personas:
8+
- app-developer
9+
- protocol-developer
10+
- chain-operator
11+
- node-operator
12+
categories:
13+
- protocol
14+
- hardhat
15+
- foundry
16+
is_imported_content: 'true'
517
---
618

719
import StackExplainer from '@/pages/stack/getting-started.mdx'

‎pages/get-started/superchain.mdx

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
---
22
title: Superchain explainer
3+
description: 'Learn about Optimism Superchain components, features, and roadmap.'
34
lang: en-US
4-
description: Learn about Optimism Superchain components, features, and roadmap.
5+
content_type: guide
6+
topic: superchain
7+
personas:
8+
- app-developer
9+
- protocol-developer
10+
- chain-operator
11+
- node-operator
12+
categories:
13+
- protocol
14+
- hardhat
15+
- foundry
16+
is_imported_content: 'true'
517
---
618

719
import SuperchainExplainer from '@/pages/superchain/superchain-explainer.mdx'

‎pages/notices/custom-gas-tokens-deprecation.mdx

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
2-
title: Deprecation of the Custom Gas Tokens
2+
title: Preparing for custom gas tokens deprecation
3+
description: >-
4+
This page outlines the details of the Custom Gas Tokens deprecation and points
5+
towards alternatives
36
lang: en-US
4-
description: This page outlines the details of the Custom Gas Tokens deprecation and points towards alternatives
7+
content_type: guide
8+
topic: custom-gas-tokens-deprecation
9+
personas:
10+
- app-developer
11+
- chain-operator
12+
categories:
13+
- security
14+
- automated-pause
15+
is_imported_content: 'false'
516
---
617

718
## Deprecation of Custom Gas Tokens

‎pages/notices/holocene-changes.mdx

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
2-
title: Preparing for Holocene Breaking Changes
3-
lang: en-US
2+
title: Preparing for Holocene breaking changes
43
description: Learn how to prepare for Holocene upgrade breaking changes.
4+
lang: en-US
5+
content_type: guide
6+
topic: holocene-changes
7+
personas:
8+
- chain-operator
9+
- node-operator
10+
categories:
11+
- security
12+
- automated-pause
13+
- protocol
14+
- infrastructure
15+
is_imported_content: 'false'
516
---
617

718
import { Steps, Callout } from 'nextra/components'

‎pages/notices/pectra-changes.mdx

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
2-
title: Preparing for Pectra Breaking Changes
3-
lang: en-US
2+
title: Preparing for Pectra breaking changes
43
description: Learn how to prepare for Pectra upgrade breaking changes.
4+
lang: en-US
5+
content_type: guide
6+
topic: pectra-changes
7+
personas:
8+
- chain-operator
9+
- node-operator
10+
categories:
11+
- security
12+
- automated-pause
13+
- protocol
14+
- infrastructure
15+
is_imported_content: 'false'
516
---
617

718
import { Steps, Callout } from 'nextra/components'

‎pages/notices/sdk-deprecation.mdx

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
---
2-
title: Deprecation of the Optimism SDK
2+
title: Preparing for Optimism SDK deprecation
3+
description: >-
4+
This page outlines the details of the Optimism SDK deprecation and guides
5+
developers to migrate to using `viem` library.
36
lang: en-US
4-
description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem` library.
7+
content_type: guide
8+
topic: sdk-deprecation
9+
personas:
10+
- app-developer
11+
categories:
12+
- protocol
13+
- ethers
14+
- viem
15+
is_imported_content: 'false'
516
---
617

718
## Preparing for Optimism SDK deprecation

0 commit comments

Comments
 (0)