Sb/u13 notice update #1522
Sb/u13 notice update #1522
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the Upgrade 13 documentation by adding informational and warning callouts in the Possibly related PRs
Suggested labels
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (1)
words.txt (1)
342-343: Clarify the new entry "reproven".
The new word "reproven" has been added here. Please verify that this entry isn’t an unintended duplicate, as the static analysis tool flagged a potential repetition. If this term is meant to support the warning callout messaging in the upgrade documentation, then it is acceptable to include it in the list.🧰 Tools
🪛 LanguageTool
[duplication] ~342-~342: Možný preklep: zopakovali ste slovo
Context: ...replayability replayor reposts reproven REQUIREDBLOCKS requiredblocks rollouts Rollups rollups Routescan rpck...(WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/notices/upgrade-13.mdx(2 hunks)words.txt(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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- 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-13.mdx
🪛 LanguageTool
words.txt
[duplication] ~342-~342: Možný preklep: zopakovali ste slovo
Context: ...replayability replayor reposts reproven REQUIREDBLOCKS requiredblocks rollouts Rollups rollups Routescan rpck...
(WORD_REPEAT_RULE)
⏰ 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
🔇 Additional comments (2)
pages/notices/upgrade-13.mdx (2)
22-28: Verify informational callout details.
The info callout clearly outlines the upgrade execution timelines with specific dates for the various chains and includes a link to the Release Management project board. Please double-check that all chain names, dates, and URLs are accurate and up-to-date.
105-109: Confirm warning callout clarity.
The warning callout effectively notifies users that withdrawals not finalized before the Fault Proofs upgrade will need to be reproven afterward, directly aligning with the new "reproven" entry in words.txt. Ensure that the mention of the 7-day window is clear and that users understand the impact on pending withdrawals.
Description
Tests
Additional context
Metadata