|
| 1 | +--- |
| 2 | +name: Docs audit results |
| 3 | +about: Template for a formal technical documentation audits run by OP Labs |
| 4 | +title: "[2024 Q4 Audit] [page-path]" |
| 5 | +labels: 'docs-audit-2024-Q4,op-labs' |
| 6 | +--- |
| 7 | + |
| 8 | +<!-- this template is intended for internal OP Labs usage --> |
| 9 | + |
| 10 | +## Description of the updates required |
| 11 | + |
| 12 | +> Write a description of the current state of the page. |
| 13 | +
|
| 14 | +## Github issue label criteria |
| 15 | + |
| 16 | +> Choose the appropriate github issue labels for each page. |
| 17 | +
|
| 18 | +<details> |
| 19 | +<summary>Priority</summary> |
| 20 | + |
| 21 | +- `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. |
| 22 | +- `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. |
| 23 | +- `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. |
| 24 | +- `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. |
| 25 | +- `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. |
| 26 | + |
| 27 | +</details> |
| 28 | + |
| 29 | +<details> |
| 30 | +<summary>T-shirt size</summary> |
| 31 | + |
| 32 | +- `s-XS`: (< 1 day) Very simple tasks that require minimal time and effort. |
| 33 | +- `s-S`: (few days) Tasks that are straightforward but require a bit more time to complete. |
| 34 | +- `s-M`: (1-2 weeks) Tasks that involve a moderate level of complexity and collaboration. |
| 35 | +- `s-L`: (several weeks) Complex tasks that require significant time investment and coordination across multiple teams. |
| 36 | +- `s-XL`: (> 1 month) Very large and complex projects that involve extensive planning, execution, and testing. |
| 37 | + |
| 38 | +</details> |
| 39 | + |
| 40 | +## MDX Metadata format |
| 41 | + |
| 42 | +> We will be adding better metadata to the header of each page. |
| 43 | +> 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? |
| 44 | +> Parse the component and feature tags to add. |
| 45 | +
|
| 46 | +--- |
| 47 | +title: "Your Title Here" |
| 48 | +tags: ["tag1", "tag2"] |
| 49 | +description: "A short description of the content." |
| 50 | +--- |
| 51 | + |
| 52 | +<details> |
| 53 | +<summary>Component tags</summary> |
| 54 | +``` |
| 55 | +op-node |
| 56 | +op-geth |
| 57 | +op-reth |
| 58 | +op-erigon |
| 59 | +op-nethermind |
| 60 | +batcher |
| 61 | +standard-bridge |
| 62 | +sequencer |
| 63 | +l1-contracts |
| 64 | +l2-contracts |
| 65 | +precompiles |
| 66 | +predeploys |
| 67 | +preinstalls |
| 68 | +op-proposer |
| 69 | +op-challenger |
| 70 | +op-gov-token |
| 71 | +op-supervisor |
| 72 | +op-conductor |
| 73 | +fp-contracts |
| 74 | +cannon |
| 75 | +op-program |
| 76 | +asterisc |
| 77 | +kona |
| 78 | +superchain-registry |
| 79 | +supersim |
| 80 | +dev-console |
| 81 | +opsm |
| 82 | +mcp |
| 83 | +mcp-l2 |
| 84 | +deputy-guardian |
| 85 | +liveness-guard |
| 86 | +dispute-mon |
| 87 | +op-beat |
| 88 | +op-signer |
| 89 | +monitorism |
| 90 | +blockspace-charters |
| 91 | +op-workbench |
| 92 | +kubernetes-infrastructure |
| 93 | +devops-tooling |
| 94 | +artifacts-packaging |
| 95 | +sequencer-in-a-box |
| 96 | +devnets |
| 97 | +op-supervisor |
| 98 | +performance-tooling |
| 99 | +peer-management-service |
| 100 | +proxyd |
| 101 | +zdd-service |
| 102 | +snapman |
| 103 | +security-tools |
| 104 | +superchain-ops |
| 105 | +``` |
| 106 | +</details> |
| 107 | + |
| 108 | +<details> |
| 109 | +<summary>Engineering tags</summary> |
| 110 | +``` |
| 111 | +eng-platforms |
| 112 | +eng-growth |
| 113 | +eng-devx |
| 114 | +eng-protocol |
| 115 | +eng-proofs |
| 116 | +eng-evm |
| 117 | +eng-security |
| 118 | +``` |
| 119 | +</details> |
| 120 | + |
0 commit comments