Fix typos and update social link in documentation #179
Conversation
- Corrected "Implecations" to "Implications" - Updated "This mean the Optimism lacks..." to "This means that Optimism lacks..."
WalkthroughThe pull request involves two primary changes: a documentation update in the Changes
Possibly related PRs
Suggested reviewers
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for polymer-docs-stealth ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
docs/learn/how-it-works/latency-can-vary.md (2)
25-25: Additional formatting improvements neededWhile the grammar fix from "This mean" to "This means" is correct, there are a few minor formatting issues to address:
- Add periods to the abbreviation "i.e." (should be "i.e.")
- Add a comma after "i.e."
Apply this change:
- Optimism references Ethereum up to 11 blocks deep, while Base references up to 16 blocks. This means that Optimism lacks the knowledge of Ethereum beyond the 11th block and for Base this is even larger i.e the first 16 Ethereum blocks. + Optimism references Ethereum up to 11 blocks deep, while Base references up to 16 blocks. This means that Optimism lacks the knowledge of Ethereum beyond the 11th block and for Base this is even larger, i.e., the first 16 Ethereum blocks.🧰 Tools
🪛 LanguageTool
[typographical] ~25-~25: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ... Ethereum beyond the 11th block and for Base this is even larger i.e the first 16 Et...(IN_NNP_COMMA)
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...he 11th block and for Base this is even larger i.e the first 16 Ethereum blocks. ![im...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~25-~25: The abbreviation “i.e.” (= that is) requires two periods.
Context: ... block and for Base this is even larger i.e the first 16 Ethereum blocks. ![image ...(I_E)
24-24: Fix heading hierarchyThe heading level jumps from h1 to h3, skipping h2. Consider updating the heading level for proper document structure:
- ### Implications + ## Implications🧰 Tools
🪛 Markdownlint (0.37.0)
24-24: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/learn/how-it-works/latency-can-vary.md(1 hunks)docusaurus.config.js(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/learn/how-it-works/latency-can-vary.md
[typographical] ~25-~25: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ... Ethereum beyond the 11th block and for Base this is even larger i.e the first 16 Et...
(IN_NNP_COMMA)
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...he 11th block and for Base this is even larger i.e the first 16 Ethereum blocks. ![im...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~25-~25: The abbreviation “i.e.” (= that is) requires two periods.
Context: ... block and for Base this is even larger i.e the first 16 Ethereum blocks. 
This PR includes the following changes:
1. Updated social link label and URL:
3. Fixed typos in "Why Latency Can Vary" documentation:
Summary by CodeRabbit
Documentation
Chores