Corrected rude grammar errors in docs #1055
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
666devs
changed the title
WalkthroughThe pull request includes textual modifications across several documentation files related to chain operators. These changes primarily focus on improving clarity, correcting typographical errors, and ensuring grammatical accuracy. Specific sections on key management, troubleshooting, chain monitoring, and operational challenges have been refined, while the overall structure and content remain unchanged. Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
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: 1
🧹 Outside diff range and nitpick comments (3)
pages/builders/chain-operators/tools/op-challenger.mdx (3)
84-89: Consider rephrasing for better readabilityThe current text repeats "needs to be" in close proximity. Consider revising to:
- * This needs to be an `op-node` archive node because challenger needs access to output roots from back when the games start. See below for important configuration details: + * Configure this to point to an `op-node` archive node, as the challenger requires access to historical output roots from game initiation. See below for important configuration details:🧰 Tools
🪛 LanguageTool
[style] ~84-~84: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ess. ####--rollup-rpc* This needs to be anop-nodearchive node because ch...(REP_NEED_TO_VB)
141-141: Improve comment formatting for clarityThe current inline comment could be structured better. Consider revising to:
- # make reproducible prestate - # challenger verifies that onchain + # Generate reproducible prestate. + # Note: Challenger verifies this value on-chain.
215-217: Enhance monitoring section presentationConsider restructuring this section for better clarity:
- Additionally, chain operators should consider running `op-dispute-mon`. It's an incredibly useful security monitoring service to keep an eye on games, basically giving chain operators visibility into all the status of the games for the last 28 days. - Chain operators can easily create their grafana dashboard for Dispute Monitor using the following json file: [Download the Dispute Monitor JSON](/resources/grafana/dispute-monitor-1718214549035.json). + Additionally, chain operators should consider running `op-dispute-mon`, a security monitoring service that provides: + + * Comprehensive visibility into game status for the last 28 days + * Real-time security monitoring capabilities + + To get started with monitoring: + 1. Set up `op-dispute-mon` + 2. Import the [Dispute Monitor Dashboard JSON](/resources/grafana/dispute-monitor-1718214549035.json) into Grafana
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (4)
pages/builders/chain-operators/management/key-management.mdx(1 hunks)pages/builders/chain-operators/management/troubleshooting.mdx(1 hunks)pages/builders/chain-operators/tools/chain-monitoring.mdx(3 hunks)pages/builders/chain-operators/tools/op-challenger.mdx(4 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/builders/chain-operators/management/key-management.mdx
- pages/builders/chain-operators/management/troubleshooting.mdx
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/tools/chain-monitoring.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/builders/chain-operators/tools/op-challenger.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/builders/chain-operators/tools/chain-monitoring.mdx
[typographical] ~37-~37: Two consecutive dots
Context: ...t presigned nonce stored in One Password.. The latest presigned nonce is identifie...
(DOUBLE_PUNCTUATION)
pages/builders/chain-operators/tools/op-challenger.mdx
[style] ~84-~84: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ess. #### --rollup-rpc * This needs to be an op-node archive node because ch...
(REP_NEED_TO_VB)
[grammar] ~167-~167: The verb ‘prestate’ does not usually follow articles like ‘a’. Check that ‘prestate’ is spelled correctly; using ‘prestate’ as a noun may be non-standard.
Context: ...their hash. * Example final URL for a prestate: * [https://example.com/prestat...
(A_INFINITIVE)
🔇 Additional comments (3)
pages/builders/chain-operators/tools/chain-monitoring.mdx (3)
22-22: LGTM: Proper comma usage
The correction from a period to a comma improves the flow and grammatical accuracy of the sentence.
27-27: LGTM: Clear technical description
The description accurately explains the Fault Monitor's functionality while maintaining proper technical terminology.
79-81: LGTM: Proper grammar and formatting
The corrections improve the text by:
- Using proper subject-verb agreement ("steps are" instead of "steps is")
- Maintaining consistent list formatting
Description
I have corrected a lot of significant and rude grammar errors found in the docs. These changes enhance the overall understanding of the documentation and improve the user experience.
Updated following files:
key-management.mdx
troubleshooting.mdx
chain-monitoring.mdx
op-challenger.mdx
Include a link to any github issues that this may close in the following form: