adding custom genesis guidance #1578
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough## Walkthrough
A new warning callout has been added to the node operator upgrade instructions in the upgrade-15.mdx documentation page. This callout informs users that when operating with a custom genesis chain configuration, the `pragueTime` parameter must be explicitly set to match the `isthmusTime` parameter. This explicit setting is necessary because, unlike configurations using network or override flags, the synchronization between `pragueTime` and `isthmusTime` does not occur automatically for custom genesis setups. The new warning is positioned between an existing informational callout regarding the missing override flag and the section describing activation time options. No changes were made to any exported or public entities in the codebase.
## Possibly related PRs
- ethereum-optimism/docs#1560: Adds an informational callout about the missing override flag for `isthmusTime` in the same upgrade-15.mdx file, closely related as both PRs address documentation callouts for upgrade parameters.
- ethereum-optimism/docs#1491: Introduces the initial Isthmus notice page template and metadata, related as both PRs modify the upgrade-15.mdx documentation regarding upgrade notices.
- ethereum-optimism/docs#1367: Updates the message-passing tutorial by refreshing code snippet references and hashes without changing tutorial content or logic, related due to updating tutorial documentation files.
## Suggested reviewers
- sbveganTip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🪛 LanguageToolwords.txt[duplication] ~2-~2: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~11-~11: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~13-~13: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~21-~21: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~25-~25: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~27-~27: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~33-~33: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~36-~36: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~40-~40: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~42-~42: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~45-~45: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~48-~48: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~50-~50: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~55-~55: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~59-~59: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~61-~61: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~78-~78: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~84-~84: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~89-~89: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~91-~91: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~93-~93: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~95-~95: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~100-~100: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~102-~102: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~110-~110: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~113-~113: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~115-~115: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~119-~119: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~121-~121: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~126-~126: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~128-~128: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~132-~132: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~147-~147: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~151-~151: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~153-~153: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~159-~159: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~162-~162: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~164-~164: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~166-~166: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~170-~170: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~173-~173: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~175-~175: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~178-~178: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~181-~181: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~186-~186: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~188-~188: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~197-~197: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~199-~199: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~201-~201: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~203-~203: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~205-~205: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~207-~207: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~209-~209: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~215-~215: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~217-~217: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~223-~223: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~240-~240: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~242-~242: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~244-~244: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~247-~247: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~249-~249: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~251-~251: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~254-~254: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~256-~256: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~258-~258: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~260-~260: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~262-~262: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~265-~265: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~279-~279: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~282-~282: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~284-~284: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~292-~292: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~294-~294: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~298-~298: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~300-~300: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~303-~303: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~305-~305: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~308-~308: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~310-~310: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~314-~314: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~316-~316: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~322-~322: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~324-~324: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~327-~327: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~331-~331: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~334-~334: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~336-~336: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~338-~338: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~344-~344: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~347-~347: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~351-~351: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~355-~355: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~360-~360: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~364-~364: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~382-~382: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~391-~391: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~393-~393: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~399-~399: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~401-~401: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~403-~403: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~431-~431: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~433-~433: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~437-~437: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~439-~439: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) [duplication] ~445-~445: Možný preklep: zopakovali ste slovo (WORD_REPEAT_RULE) ⏰ Context from checks skipped due to timeout of 90000ms (3)
🔇 Additional comments (1)
🪧 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
🔭 Outside diff range comments (1)
pages/notices/upgrade-15.mdx (1)
2-2:⚠️ Potential issueInconsistent spelling of “Isthmus”
The frontmatter title (Upgrade 15 - Isthumus Hard Fork, line 2) and the H1 header (# Upgrade 15: Isthumus Hard Fork, line 20) both use “Isthumus” instead of the correct term “Isthmus.”Please correct these typos to “Isthmus” for consistency with the rest of the docs and external references.
Also applies to: 20-20
🧹 Nitpick comments (1)
pages/notices/upgrade-15.mdx (1)
124-126: Improve clarity and imperative tone of callout
This warning callout currently uses a conditional mood and contains a comma splice. To align with our style guide (imperative voice, sentence-case body text, Oxford comma) and improve clarity, consider updating it as follows:- <Callout type="warning"> - If you use custom genesis chain configuration, you need to set the `pragueTime` to the same value as the `isthmusTime`. It is not automatically set, this automatically happens for chains using the network flags and also when using the override flags. - </Callout> + <Callout type="warning"> + When using a custom genesis chain configuration, set the `pragueTime` to match the `isthmusTime`. This synchronization happens automatically when using network flags or override flags, but must be done manually for custom configurations. + </Callout>
- Switch to imperative mood (“set the
pragueTime”).- Break into two sentences to fix the comma splice.
- Clarify which cases are automatic versus manual.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/upgrade-15.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- 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/notices/upgrade-15.mdx
Description
Tests
Additional context
Metadata