fix spelling #1288
fix spelling #1288
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request involves a series of minor documentation improvements across multiple Markdown files in the pages/stack directory. The changes primarily focus on grammatical corrections, spelling fixes, and minor formatting adjustments. These updates include correcting singular/plural forms, fixing typographical errors, improving sentence structure, and ensuring consistent formatting. The modifications do not alter the fundamental content or functionality of the documentation but aim to enhance readability and accuracy. The changes span various sections of the documentation, including beta features, components, design principles, transaction methods, interoperability, and system outages. Suggested labels
Suggested reviewers
Possibly related PRs
Note: No sequence diagram is generated for this PR as the changes are primarily textual and do not involve significant functional or architectural modifications. 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
Documentation and Community
|
![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
🧹 Nitpick comments (2)
pages/stack/transactions/transaction-finality.mdx (1)
27-27: Add a comma before the conjunction 'but'.Add a comma to properly separate the independent clauses in the compound sentence.
- the transaction is in a block but its data has not yet been posted to Ethereum + the transaction is in a block, but its data has not yet been posted to Ethereum🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ating that the transaction is in a block but its data has not yet been posted to Eth...(COMMA_COMPOUND_SENTENCE_2)
pages/stack/components.mdx (1)
91-91: Add a comma before the conjunction 'but'.Add a comma to properly separate the independent clauses in the compound sentence.
- mechanism used today but it replaces + mechanism used today, but it replaces🧰 Tools
🪛 LanguageTool
[uncategorized] ~91-~91: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n-based Fault Proof mechanism used today but it replaces the MultiSig challenger wit...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
pages/stack/beta-features.mdx(1 hunks)pages/stack/components.mdx(1 hunks)pages/stack/design-principles.mdx(2 hunks)pages/stack/features/send-raw-transaction-conditional.mdx(1 hunks)pages/stack/interop/explainer.mdx(1 hunks)pages/stack/interop/security.mdx(1 hunks)pages/stack/rollup/outages.mdx(1 hunks)pages/stack/transactions/transaction-finality.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (6)
- pages/stack/rollup/outages.mdx
- pages/stack/interop/security.mdx
- pages/stack/features/send-raw-transaction-conditional.mdx
- pages/stack/design-principles.mdx
- pages/stack/beta-features.mdx
- pages/stack/interop/explainer.mdx
🧰 Additional context used
📓 Path-based instructions (2)
pages/stack/components.mdx (1)
Pattern **/*.mdx: "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. 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 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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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.
"
pages/stack/transactions/transaction-finality.mdx (1)
Pattern **/*.mdx: "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. 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 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:
- Use sentence case, capitalizing only the first word.
- 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.
- 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.
"
🪛 LanguageTool
pages/stack/components.mdx
[uncategorized] ~91-~91: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n-based Fault Proof mechanism used today but it replaces the MultiSig challenger wit...
(COMMA_COMPOUND_SENTENCE)
pages/stack/transactions/transaction-finality.mdx
[uncategorized] ~27-~27: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ating that the transaction is in a block but its data has not yet been posted to Eth...
(COMMA_COMPOUND_SENTENCE_2)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
pages/stack/beta-features.mdx
report - reports
pages/stack/components.mdx
Fault Proof mechanism - Fault Proof mechanism
pages/stack/design-principles.mdx
featureset - feature set
(https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306)) -(https://web.archive.org/web/20231127160757/https://medium.com/ethereum-optimism/introducing-evm-equivalence-5c2021deb306))
pages/stack/features/send-raw-transaction-conditional.mdx
disincentive - disincentivize
pages/stack/interop/explainer.mdx
E> - E.
usafe - unsafe
pages/stack/interop/security.mdx
appear - appearing
pages/stack/rollup/outages.mdx
systems - system
pages/stack/transactions/transaction-finality.mdx
"unsafe"- - "unsafe" -