Updating the issue templates, fixing linter, and adding activation time #1213
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request encompasses updates across multiple files in the repository. The primary changes include modifying the GitHub issue template for documentation requests, updating the network upgrades documentation with a new Holocene upgrade entry, making a minor formatting adjustment to the schemas documentation, and revising the Sequence DiagramsequenceDiagram
participant User
participant IssueTemplate
participant Documentation
User->>IssueTemplate: Submits documentation request
IssueTemplate->>User: Guides through detailed request
User->>Documentation: Provides clear description
Documentation->>User: Confirms understanding
User->>IssueTemplate: Adds user stories and action items
IssueTemplate->>Documentation: Facilitates comprehensive documentation process
Possibly related PRs
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)
.github/ISSUE_TEMPLATE/general_docs_request.md (2)
9-9: Improve instruction clarity and grammarThe instruction line contains a grammatical error and could be more concise.
-<!-- please fill out the description and acceptance criteria to the best to your ability. While the other sections are optional, it makes resolving the issue much easier. --> +<!-- Please fill out the description and acceptance criteria to the best of your ability. The optional sections help expedite issue resolution. -->
14-15: Enhance section headers consistencyThe template's section headers could benefit from consistent formatting and clarity.
-## Acceptance criteria +## Acceptance Criteria -<!-- Clearly list out the definition of done. --> +<!-- List the specific requirements that must be met to consider this documentation complete. --> -## User stories +## User Stories -<!-- User stories that illustrate the benefits of this issue. For example, this documentation improvement will allow user X to be able to Y. --> +<!-- Describe who benefits from this documentation and how. Example: "As a node operator, I want to understand network upgrades so I can prepare for upcoming changes." --> -## Action items +## Action Items -<!-- Clear steps to take to complete this issue --> +<!-- List specific, actionable steps needed to complete this documentation request -->Also applies to: 17-18, 24-25
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/ISSUE_TEMPLATE/general_docs_request.md(1 hunks)pages/builders/node-operators/network-upgrades.mdx(1 hunks)pages/chain/identity/schemas.mdx(1 hunks)words.txt(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/chain/identity/schemas.mdx
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/node-operators/network-upgrades.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.
"
🔇 Additional comments (3)
words.txt (1)
311-312: Verify removal of blockchain-related termsWhile the new terms are properly formatted and placed, the removal of terms like "Arbitrum's", "ConsenSys", and "Sepolia" should be verified as these are commonly used in blockchain documentation.
Also applies to: 391-391
pages/builders/node-operators/network-upgrades.mdx (2)
20-28: Ensure consistent table formattingThe table formatting is clean and well-structured. The links to specifications and governance approvals are properly formatted.
20-22: Verify Holocene upgrade activation timesThe addition of the Holocene upgrade follows the established format. However, please verify the activation timestamps with the governance proposal to ensure accuracy.
✅ Verification successful
Timestamps in documentation are consistent and verified
The timestamps in the network upgrades table match the official documentation in
holocene-changes.mdx:
- Sepolia activation: Tue Nov 26 15:00:00 UTC 2024 (1732633200)
- Mainnet activation: Thu Jan 9 18:00:01 UTC 2025 (1736445601)
These timestamps are consistently documented across the codebase and are linked to the approved governance proposal. The documentation follows proper formatting guidelines and provides accurate information about the Holocene upgrade schedule.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify timestamp consistency with governance proposal echo "Checking governance proposal for timestamp confirmation..." gh api graphql -f query='{ repository(owner: "ethereum-optimism", name: "optimism") { issues(first: 1, labels: ["governance"], search: "Holocene") { nodes { body } } } }'Length of output: 645
Script:
#!/bin/bash # Let's try a different approach to verify the timestamps by checking the superchain registry echo "Checking Holocene upgrade timestamps in superchain registry..." curl -s https://raw.githubusercontent.com/ethereum-optimism/superchain-registry/main/superchain/configs/mainnet/superchain.toml | grep -A 5 "Holocene" curl -s https://raw.githubusercontent.com/ethereum-optimism/superchain-registry/main/superchain/configs/sepolia/superchain.toml | grep -A 5 "Holocene" # Also check if there are any related configuration files in the repository echo -e "\nChecking for Holocene-related configuration files..." fd -t f holocene -iLength of output: 623
Script:
#!/bin/bash # Let's check the content of the Holocene changes file for timestamp information echo "Checking Holocene changes documentation..." cat pages/builders/notices/holocene-changes.mdx # Let's also check if there are any other files mentioning the Holocene timestamps echo -e "\nChecking for files containing Holocene timestamps..." rg -i "1736445601|1732633200" --type mdxLength of output: 8121
Description