feat(drunemeton-1): mark as discontinued #852
Conversation
WalkthroughThe pull request includes updates to the README files for the Changes
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
CodeRabbit Configuration File (
|
![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 (4)
chains/drunemeton-1/README.md.gtpl (2)
11-13: LGTM: Discontinuation note addedThe added note clearly communicates the network's discontinuation, which is crucial information for users. The use of the "IMPORTANT" admonition ensures visibility.
Consider adding a brief explanation or link for users seeking more information about the discontinuation. For example:
> [!IMPORTANT] -> This network was discontinued on 2024-09-30. +> This network was discontinued on 2024-09-30. For more information, please refer to [our announcement](link-to-announcement).
Line range hint
16-85: Consider addressing outdated informationThe README still contains detailed information about registering validators and genesis information, which is no longer applicable due to the network's discontinued status. While this information may be valuable for historical purposes, it might confuse users who overlook the deprecation notice.
Consider one of the following approaches:
- Remove or comment out the outdated information.
- Move the outdated information to a separate "Historical Information" section.
- Add a clear disclaimer at the beginning of these sections indicating that the information is no longer applicable.
For example, you could add:
## Historical Information > [!WARNING] > The following information is no longer applicable as the network has been discontinued. It is preserved for historical purposes only. (rest of the content)This approach would help prevent confusion while still preserving the historical data.
chains/drunemeton-1/README.md (2)
11-12: Important note about network discontinuation is well-placed.The addition of this note provides crucial information about the network's status. The date format is clear and unambiguous.
Consider adding a brief explanation or link for users seeking more information about the discontinuation, e.g.:
> [!IMPORTANT] -> This network was discontinued on 2024-09-30. +> This network was discontinued on 2024-09-30. For more information, please visit [link to announcement or FAQ].
Line range hint
1-24: Consider updating the document for consistency with the network's discontinued status.While the stability badge and the important note about discontinuation have been added, other parts of the document may now be misleading or irrelevant. Consider the following suggestions:
- Remove or update the chain-height badge on line 9, as it may no longer be applicable.
- Add a clear statement at the beginning of the document indicating that the information is historical and no longer applicable for new participants.
- Update or remove the "Register in the Genesis" section starting from line 17, as it's no longer relevant for a discontinued network.
Here's a suggested addition at the beginning of the document:
+> [!WARNING] +> This document contains historical information about the discontinued okp4-drunemeton-1 network. The instructions and information below are no longer applicable for new participants. + <!-- generated file - do not edit --> # 🔗 `okp4-drunemeton-1`Consider reviewing and updating the rest of the document to reflect its historical nature and remove any instructions that are no longer applicable.
🧰 Tools
🪛 LanguageTool
[style] ~14-~14: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 1805 characters long)
Context: ...discontinued on 2024-09-30. > [!IMPORTANT] > This network was originally...(EN_EXCESSIVE_EXCLAMATION)
[style] ~15-~15: This phrase is redundant. Consider writing “created”.
Context: ...- --> > [!IMPORTANT] > This network was originally created under the formerOKP4brand. ## Regi...(ORIGINALLY_CREATED)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- chains/drunemeton-1/README.md (1 hunks)
- chains/drunemeton-1/README.md.gtpl (1 hunks)
- chains/nemeton/README.md (1 hunks)
- chains/nemeton/README.md.gtpl (1 hunks)
✅ Files skipped from review due to trivial changes (2)
- chains/nemeton/README.md
- chains/nemeton/README.md.gtpl
🔇 Additional comments (3)
chains/drunemeton-1/README.md.gtpl (2)
5-5: LGTM: Stability badge updated correctlyThe stability badge has been appropriately updated from "beta" to "deprecated", accurately reflecting the network's new status. The color change to dark red effectively communicates the deprecation.
Line range hint
1-85: Summary of README.md.gtpl changesThe changes effectively mark the drunemeton-1 project as discontinued:
- The stability badge has been updated to "deprecated".
- An important note about the network discontinuation has been added.
These changes align well with the PR objectives. However, consider:
- Adding more context to the discontinuation note.
- Addressing the outdated information in the rest of the document to prevent confusion.
Overall, the core objective has been met, but a few refinements could further improve clarity and user experience.
chains/drunemeton-1/README.md (1)
5-5: Stability badge update is appropriate.The change from "beta" to "deprecated" accurately reflects the current status of the network. The red color (922b21) of the badge is suitable for indicating a deprecated status.
Self explanatory.