From 08664ea0fd13b33d63902e64c4c92cef9fc4e250 Mon Sep 17 00:00:00 2001 From: Anonim Date: Sat, 9 Nov 2024 13:16:14 +0300 Subject: [PATCH] Updated docs files with errors --- pages/chain/security/security-policy.mdx | 2 +- pages/connect/contribute/style-guide.mdx | 8 ++++---- pages/connect/resources/glossary.mdx | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pages/chain/security/security-policy.mdx b/pages/chain/security/security-policy.mdx index 85a776ff4..661a510ab 100644 --- a/pages/chain/security/security-policy.mdx +++ b/pages/chain/security/security-policy.mdx @@ -53,4 +53,4 @@ Alongside this policy, maintainers also reserve the right to: * Bypass this policy and publish details on a shorter timeline. * Directly notify a subset of downstream users prior to making a public announcement. -This policy is based the [Geth](https://geth.ethereum.org/) team's [silent patch policy](https://geth.ethereum.org/docs/developers/geth-developer/disclosures#why-silent-patches). +This policy is based on the [Geth](https://geth.ethereum.org/) team's [silent patch policy](https://geth.ethereum.org/docs/developers/geth-developer/disclosures#why-silent-patches). diff --git a/pages/connect/contribute/style-guide.mdx b/pages/connect/contribute/style-guide.mdx index dbca6be12..2149e5add 100644 --- a/pages/connect/contribute/style-guide.mdx +++ b/pages/connect/contribute/style-guide.mdx @@ -10,7 +10,7 @@ import { Callout } from 'nextra/components' This Style Guide aims to assist Optimists in writing technical content with a consistent voice, tone, and style. See the [glossary](/connect/resources/glossary) for an alphabetical listing of commonly used words, terms, and concepts used throughout the technical docs and across the OP Collective. -This doc doesn't cover all questions or use-cases. Our guide is based off the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/). Please reference their guide for any use-case or situation we do not cover here. +This doc doesn't cover all questions or use-cases. Our guide is based on the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/). Please reference their guide for any use-case or situation we do not cover here. * For docs-related questions or comments, create an issue in the [docs repo](https://github.com/ethereum-optimism/docs/issues). * For support-related questions or comments, create an issue in the [developers repo](https://github.com/ethereum-optimism/developers/issues). @@ -178,7 +178,7 @@ We aim to use consistent organization that is also user-centered and accessible. ### Listing prerequisites (before you begin) * Add a "Before You Begin" section at the top of the document if there are tasks a user needs to complete before continuing with the current task, e.g. installing a module, downloading a software update, etc. -* Use the title "Before You Begin"and format as H2. It should follow the page overview/intro section or table of contents. +* Use the title "Before You Begin" and format as H2. It should follow the page overview/intro section or table of contents. * Include all the tasks the user needs to complete, including links to aid in usability. Use a bulleted list for more than 2 prerequisite items. **Example**:
@@ -501,7 +501,7 @@ Please use `*` instead of `-` for items in a list. This maintains consistency ac ### Punctuation -* **Ampersand (&)** Only use "&"in headings where items are grouped or in proper names. Do not use in sentences. +* **Ampersand (&)** Only use "&" in headings where items are grouped or in proper names. Do not use in sentences. * **Colon (:)** Use to introduce a list or series. @@ -523,4 +523,4 @@ Please use `*` instead of `-` for items in a list. This maintains consistency ac **Example**: `developer-focused product` or `company-wide holiday` -* **Slash (/)** Avoid using as the slash is reserved for file names (see above). Use "or," "and,"or "or both"instead. +* **Slash (/)** Avoid using as the slash is reserved for file names (see above). Use "or," "and," or "both" instead. diff --git a/pages/connect/resources/glossary.mdx b/pages/connect/resources/glossary.mdx index 9261933f2..e1c411053 100644 --- a/pages/connect/resources/glossary.mdx +++ b/pages/connect/resources/glossary.mdx @@ -33,7 +33,7 @@ block, and output block properties, which are derived after executing the block' #### Block time L2 block time is 2 seconds, meaning there is an L2 block at every 2s [time slot](#time-slot). -*Post-merge*, it could be said the that L1 block time is 12s as that is the L1 [time slot](#time-slot). However, in +*Post-merge*, it could be said that L1 block time is 12s as that is the L1 [time slot](#time-slot). However, in reality the block time is variable as some time slots might be skipped. Pre-merge, the L1 block time is variable, though it is on average 13s. #### Delegation @@ -335,7 +335,7 @@ a better compression rate, hence reducing data availability costs. #### Channel Frame Chunk of data belonging to a [channel](#channel). [Batcher transactions](#batcher-transaction) carry one or -multiple frames. The reason to split a channel into frames is that a channel might too large to include in a single +multiple frames. The reason to split a channel into frames is that a channel might be too large to include in a single batcher transaction. #### Channel Timeout