Merge remote-tracking branch 'upstream/main' into feat/devnet-tutorial

.coderabbit.yaml

@@ -4,18 +4,25 @@ reviews:
   high_level_summary: false
   poem: false
   review_status: false
-  collapse_walkthrough: false
+  collapse_walkthrough: true
+  changed_files_summary: false
   path_instructions:
     - path: "**/*.mdx"
       instructions: |
         "ALWAYS review Markdown content THOROUGHLY with the following criteria:
         - Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
         - Avoid gender-specific language and use the imperative form.
-        - Monitor capitalization for emphasis. Use **bold** for prominence instead of all caps or italics.
+        - Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
         - Ensure proper nouns are capitalized in sentences.
         - Apply the Oxford comma.
-        - Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
+        - Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
         - Use correct spelling and grammar at all times (IMPORTANT).
+        - For H1, H2, and H3 headers:
+          1. Use sentence case, capitalizing only the first word.
+          2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
+          3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
+        - Flag any headers that seem to inconsistently apply these rules for manual review.
+        - When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
         "
   auto_review:
     enabled: true

.github/CODEOWNERS

@@ -1,16 +1,8 @@
 *       @ethereum-optimism/docs-reviewers
 
-# Giving Node Squad review privileges to the following sections
-/pages/builders/chain-operators/    @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad
-/pages/chain/                       @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad
-/pages/stack/                       @ethereum-optimism/docs-reviewers @ethereum-optimism/node-squad
-
 # Giving Marine privileges to review RPC providers, account abstraction, oracles, alt-da, and block explorers
 /pages/builders/tools/connect/rpc-providers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
 /pages/builders/tools/build/block-explorers.mdx @ethereum-optimism/docs-reviewers @0xmariniere
 /pages/builders/tools/build/oracles.mdx @ethereum-optimism/docs-reviewers @0xmariniere
 /pages/builders/chain-operators/features/alt-da-mode.mdx @ethereum-optimism/docs-reviewers @0xmariniere
 /pages/builders/tools/build/account-abstraction.mdx @ethereum-optimism/docs-reviewers @0xmariniere
-
-# Giving Binji privileges to review NFT tools
-/pages/builders/tools/build/nft-tools.mdx @ethereum-optimism/docs-reviewers @binjix23

.github/ISSUE_TEMPLATE/docs_audit_results.md

@@ -9,32 +9,60 @@ labels: 'docs-audit-2024-Q4,op-labs'
 
 ## Description of the updates required
 
-> Write a description of the current state of the page.
+<!-- Write a description of the current state of the page. -->
+
+### Acceptance criteria
+
+<!-- Definition of done for the assignee -->
+
+### Resources
+
+<!-- Supporting docs, points of contact, and any additional helpful info -->
+
+### Action items
+
+<!-- The process for working through this issue for example:
+1. Read through resources and meet with SME
+2. Write the first draft
+3. Share draft with SMEs and implement feedback
+4. Peer review
+5. Final SME review
+6. Publish -->
 
 ## Github issue label criteria
 
 > Choose the appropriate github issue labels for each page.
 
 <details>
+
 <summary>Priority</summary>
 
 - `p-on-hold`: (Defer) Tasks that are currently not actionable due to various reasons like waiting for external inputs, dependencies, or resource constraints. These are reviewed periodically to decide if they can be moved to a more active status.
 - `p-low`: (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. These tasks are often more about quality of life improvements rather than essential needs.
 - `p-medium`: (Could do) Tasks that need to be done but are less critical than high-priority tasks. These often improve processes or efficiency but can be postponed if necessary without immediate severe repercussions.
 - `p-high`: (Should do) Important tasks that contribute significantly to long-term goals but may not have an immediate deadline. Delaying these tasks could have considerable negative effects but are not as immediate as critical tasks.
 - `p-critical`: Tasks that have immediate deadlines or significant consequences if not completed on time. These are non-negotiable and often linked to core business functions or legal requirements. 
-
 </details>
 
 <details>
+
 <summary>T-shirt size</summary>
 
 - `s-XS`: (< 1 day) Very simple tasks that require minimal time and effort.
 - `s-S`: (few days) Tasks that are straightforward but require a bit more time to complete.
 - `s-M`: (1-2 weeks) Tasks that involve a moderate level of complexity and collaboration.
 - `s-L`: (several weeks) Complex tasks that require significant time investment and coordination across multiple teams. 
 - `s-XL`: (> 1 month) Very large and complex projects that involve extensive planning, execution, and testing. 
+</details>
 
+<details>
+
+<summary>Content evaluation</summary>
+- `a-delete`: don't need this page 
+- `a-duplicate`: some content lives elsewhere 
+- `a-minor`: needs small revisions 
+- `a-moderate`: needs moderate revisions 
+- `a-critical`: needs a lot of work
 </details>
 
 ## MDX Metadata format
@@ -53,6 +81,7 @@ description: "A short description of the content."
 
 <details>
 <summary>Component tags</summary>
+
 ```
 op-node
 op-geth
@@ -104,11 +133,13 @@ zdd-service
 snapman
 security-tools
 superchain-ops
+op-deployer
 ```
 </details>
 
 <details>
 <summary>Engineering tags</summary>
+
 ```
 eng-platforms
 eng-growth

.github/ISSUE_TEMPLATE/suggest_glossary_term.yaml

@@ -18,7 +18,7 @@ body:
       options:
         - label: This is a term not already found in the glossary (for similar terms, please consider the benefits of a new term vs updating an existing term)
           required: true
-        - label: This term/definition is not a product advertisement or contain other promotional content
+        - label: This term/definition is not a product advertisement and does not contain other promotional content
           required: true
         - label: This term/definition is directly relevant to Optimism
           required: true
@@ -39,15 +39,15 @@ body:
   - type: textarea
     id: glossary_term_sources
     attributes:
-      label: Sources, if any (please do not submit copywrited content without appropriate approval)
+      label: Sources, if any (please do not submit copyrighted content without appropriate approval)
       description: Please list any sources utilized
     validations:
       required: false
   - type: textarea
     id: glossary_terms_optimismdotio_links
     attributes:
       label: Optimism.io links
-      description: If appropriate/available, please suggest an internal optimism.io link that would expand someones learning of this term
+      description: If appropriate/available, please suggest an internal optimism.io link that would expand someone's learning of this term
   - type: textarea
     id: glossary_term_additional_context
     attributes:

.github/ISSUE_TEMPLATE/suggest_tutorial.yaml

@@ -22,7 +22,7 @@ body:
     id: tutorial_description
     attributes:
       label: Tutorial description
-      description: Summarize what the user should be able to accomplish by following tutorial
+      description: Summarize what the user should be able to accomplish by following the tutorial
     validations:
       required: true
   - type: input