From 6957e9bb0e743c769a0210f9aeab328054fd39cb Mon Sep 17 00:00:00 2001 From: soyboy Date: Tue, 10 Sep 2024 10:36:13 -0600 Subject: [PATCH 1/5] adding audit template --- .github/ISSUE_TEMPLATE/docs_audit_results.md | 119 +++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs_audit_results.md diff --git a/.github/ISSUE_TEMPLATE/docs_audit_results.md b/.github/ISSUE_TEMPLATE/docs_audit_results.md new file mode 100644 index 000000000..b0ba47717 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_audit_results.md @@ -0,0 +1,119 @@ +--- +name: Docs audit results +about: Template for a formal technical documentation audits run by OP Labs +title: "[2024 Q4 Audit] [page-path]" +labels: 'docs-audit-2024-Q4,op-labs' +--- + + + +## Description of the updates required + +> Write a description of the current state of the page. + +## Github issue label criteria + +> Choose the appropriate github issue labels for each page. + +**Content evaluation:** + +- `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 + +**Priority:** + +- `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. + +**T-shirt size:** + +- `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. + + +## MDX Metadata format + +> We will be adding better metadata to the header of each page. Parse the component and feature tags to add. + +``` +tags: ["tag1", "tag2"] +``` + +
+Component tags +``` +op-node +op-geth +op-reth +op-erigon +op-nethermind +batcher +standard-bridge +sequencer +l1-contracts +l2-contracts +precompiles +predeploys +preinstalls +op-proposer +op-challenger +op-gov-token +op-supervisor +op-conductor +fp-contracts +cannon +op-program +asterisc +kona +superchain-registry +supersim +dev-console +opsm +mcp +mcp-l2 +deputy-guardian +liveness-guard +dispute-mon +op-beat +op-signer +monitorism +blockspace-charters +op-workbench +kubernetes-infrastructure +devops-tooling +artifacts-packaging +sequencer-in-a-box +devnets +op-supervisor +performance-tooling +peer-management-service +proxyd +zdd-service +snapman +security-tools +superchain-ops +``` +
+ +
+Engineering tags +``` +eng-platforms +eng-growth +eng-devx +eng-protocol +eng-proofs +eng-evm +eng-security +``` +
+ From 17af7cff9098275493d12e8b18dce4eca82bb828 Mon Sep 17 00:00:00 2001 From: soyboy Date: Tue, 10 Sep 2024 10:39:28 -0600 Subject: [PATCH 2/5] drop downs --- .github/ISSUE_TEMPLATE/docs_audit_results.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/docs_audit_results.md b/.github/ISSUE_TEMPLATE/docs_audit_results.md index b0ba47717..15cd4cf9c 100644 --- a/.github/ISSUE_TEMPLATE/docs_audit_results.md +++ b/.github/ISSUE_TEMPLATE/docs_audit_results.md @@ -15,7 +15,8 @@ labels: 'docs-audit-2024-Q4,op-labs' > Choose the appropriate github issue labels for each page. -**Content evaluation:** +
+Content evaluation - `a-delete`: don't need this page - `a-duplicate`: some content lives elsewhere @@ -23,7 +24,10 @@ labels: 'docs-audit-2024-Q4,op-labs' - `a-moderate`: needs moderate revisions - `a-critical`: needs a lot of work -**Priority:** +
+ +
+Priority - `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. @@ -31,7 +35,10 @@ labels: 'docs-audit-2024-Q4,op-labs' - `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. -**T-shirt size:** +
+ +
+T-shirt size - `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. @@ -39,6 +46,7 @@ labels: 'docs-audit-2024-Q4,op-labs' - `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. +
## MDX Metadata format From 752ca0e6c38ae85833c3761bf2d965f7a75ab7a3 Mon Sep 17 00:00:00 2001 From: soyboy Date: Tue, 10 Sep 2024 10:52:58 -0600 Subject: [PATCH 3/5] fixing broken links --- pages/builders/chain-operators/configuration/rollup.mdx | 2 +- pages/stack/protocol/fault-proofs/fp-components.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/builders/chain-operators/configuration/rollup.mdx b/pages/builders/chain-operators/configuration/rollup.mdx index 1cea5f099..2acaecf4d 100644 --- a/pages/builders/chain-operators/configuration/rollup.mdx +++ b/pages/builders/chain-operators/configuration/rollup.mdx @@ -442,7 +442,7 @@ SuperchainConfig. Has the ability to pause withdrawals. * **Recommended value:** * **Notes:** Must not be `address(0)` * **Standard Config Requirement:** [0x09f7150D8c019BeF34450d6920f6B3608ceFdAf2](https://etherscan.io/address/0x09f7150D8c019BeF34450d6920f6B3608ceFdAf2) -A 1/1 Safe owned by the Security Council Safe, with the [Deputy Guardian Module](https://specs.optimism.io/experimental/security-council-safe.html#deputy-guardian-module) +A 1/1 Safe owned by the Security Council Safe, with the [Deputy Guardian Module](https://specs.optimism.io/protocol/safe-extensions.html#deputy-guardian-module) enabled to allow the Optimism Foundation to act as Guardian. *** diff --git a/pages/stack/protocol/fault-proofs/fp-components.mdx b/pages/stack/protocol/fault-proofs/fp-components.mdx index 72e8bb0a1..1027cb406 100644 --- a/pages/stack/protocol/fault-proofs/fp-components.mdx +++ b/pages/stack/protocol/fault-proofs/fp-components.mdx @@ -16,7 +16,7 @@ The system is designed to eventually enable secure bridging without central fall The modular design of the fault proof system lays the foundation for a multi-proof future, inclusive of ZK proofs, and significantly increases the opportunities for ecosystem contributors to build alternative fault proof components to secure the system. - Visit the [Immunefi bug bounty page](https://immunefi.com/bounty/optimism/?ref=blog.oplabs.co) for details on testing and helping to build a robust fault proof system. + Visit the [Immunefi bug bounty page](https://immunefi.com/bounty/optimism/) for details on testing and helping to build a robust fault proof system. ## System Design & Modularity From cf7f43dfe10184c94894839ee63a4b379889ca26 Mon Sep 17 00:00:00 2001 From: soyboy Date: Wed, 11 Sep 2024 09:25:51 -0400 Subject: [PATCH 4/5] updating metadata description section --- .github/ISSUE_TEMPLATE/docs_audit_results.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/docs_audit_results.md b/.github/ISSUE_TEMPLATE/docs_audit_results.md index 15cd4cf9c..d0ce0eda2 100644 --- a/.github/ISSUE_TEMPLATE/docs_audit_results.md +++ b/.github/ISSUE_TEMPLATE/docs_audit_results.md @@ -50,11 +50,15 @@ labels: 'docs-audit-2024-Q4,op-labs' ## MDX Metadata format -> We will be adding better metadata to the header of each page. Parse the component and feature tags to add. +> We will be adding better metadata to the header of each page. +> If I was actively searching for this page on google and this description was the search result, would I know it's the correct page? +> Parse the component and feature tags to add. -``` +--- +title: "Your Title Here" tags: ["tag1", "tag2"] -``` +description: "A short description of the content." +---
Component tags From 1139eab7fbf6bde8a9c05719ccafc2f8749e366e Mon Sep 17 00:00:00 2001 From: soyboy Date: Wed, 11 Sep 2024 09:36:20 -0400 Subject: [PATCH 5/5] removing content eval --- .github/ISSUE_TEMPLATE/docs_audit_results.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/docs_audit_results.md b/.github/ISSUE_TEMPLATE/docs_audit_results.md index d0ce0eda2..61adf9e98 100644 --- a/.github/ISSUE_TEMPLATE/docs_audit_results.md +++ b/.github/ISSUE_TEMPLATE/docs_audit_results.md @@ -15,17 +15,6 @@ labels: 'docs-audit-2024-Q4,op-labs' > Choose the appropriate github issue labels for each page. -
-Content evaluation - -- `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 - -
-
Priority