Update consensus-config.mdx: add override.granite #955
Conversation
WalkthroughThe pull request introduces a new configuration option in the Changes
Possibly related PRs
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
|
✅ Deploy Preview for docs-optimism 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 (1)
pages/builders/node-operators/configuration/consensus-config.mdx (1)
363-372: Improve formatting and consistency of the newoverride.granitesection.The new section looks good overall, but there are a few minor improvements we can make:
- Capitalize "Granite" as it's a proper noun referring to a specific fork.
- Use bold for emphasis instead of all caps for "The default value".
- Remove extra blank lines for consistency with other sections.
Here's the suggested revision:
### override.granite - -Manually specify the granite fork timestamp, overriding the bundled setting. The default value is `0`. - +Manually specify the Granite fork timestamp, overriding the bundled setting. **The default value is `0`.** <Tabs items={['Syntax', 'Example', 'Environment Variable']}> <Tabs.Tab>`--override.granite=<value>`</Tabs.Tab> <Tabs.Tab>`--override.granite=0`</Tabs.Tab> <Tabs.Tab>`OP_NODE_OVERRIDE_GRANITE=0`</Tabs.Tab> </Tabs> -These changes will improve consistency with the rest of the document and adhere more closely to the provided coding guidelines.
🧰 Tools
🪛 LanguageTool
[style] ~369-~369: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... <Tabs.Tab>--override.granite=0</Tabs.Tab> <Tabs.Tab>`OP_NODE_OVERRIDE_GRANITE=...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/builders/node-operators/configuration/consensus-config.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/node-operators/configuration/consensus-config.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. Use bold for prominence instead of all caps or italics.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, 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).
"
🪛 LanguageTool
pages/builders/node-operators/configuration/consensus-config.mdx
[style] ~369-~369: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... <Tabs.Tab>--override.granite=0</Tabs.Tab> <Tabs.Tab>`OP_NODE_OVERRIDE_GRANITE=...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Description
Adding the description on how to manually specify the Granite fork timestamp