docs: fixes for Release Notes v22.0.0 and v21.0.0 #6498
Conversation
platformsign has been released in v21 and name there is wrong: platformsign vs signplatform
|
it's tiny and not critical changes, but I feel like it is worth to get merged. |
WalkthroughThe pull request introduces release notes for Dash Core versions v22.0.0 and v21.0.0, documenting significant protocol and network upgrades. For version v22.0.0, the release focuses on several key technical enhancements:
For version v21.0.0, the release highlights include:
These releases represent significant evolutionary steps in the Dash Core software architecture, focusing on network security, transaction efficiency, and improved user experience. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
doc/release-notes/dash/release-notes-21.0.0.md (1)
238-238: Fix bullet point style inconsistencyThe bullet point style should be consistent throughout the document. Use asterisk (*) instead of dash (-) for unordered lists.
- - A new `quorum platformsign` RPC is added for Platform needs. This composite command limits Platform to only request signatures from the Platform quorum type. It is equivalent to `quorum sign <platform type>`. + * A new `quorum platformsign` RPC is added for Platform needs. This composite command limits Platform to only request signatures from the Platform quorum type. It is equivalent to `quorum sign <platform type>`.🧰 Tools
🪛 Markdownlint (0.37.0)
238-238: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
doc/release-notes.md (1)
90-90: Fix markdown list indentationThe static analysis tool indicates incorrect list indentation in two places.
Apply this diff to fix the indentation:
- - Fixed issues with building Dash Core on FreeBSD. + - Fixed issues with building Dash Core on FreeBSD. - - `BRR` (`realloc`), `DIP0020`, `DIP0024`, `V19`, `V20`, and `MN_RR` hardforks are now activated at **block 2** instead of block **300** on devnets. + - `BRR` (`realloc`), `DIP0020`, `DIP0024`, `V19`, `V20`, and `MN_RR` hardforks are now activated at **block 2** instead of block **300** on devnets.Also applies to: 156-156
🧰 Tools
🪛 Markdownlint (0.37.0)
90-90: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
doc/release-notes.md(2 hunks)doc/release-notes/dash/release-notes-21.0.0.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
doc/release-notes/dash/release-notes-21.0.0.md
238-238: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
doc/release-notes.md
90-90: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
156-156: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
🔇 Additional comments (3)
doc/release-notes.md (3)
89-90: LGTM: FreeBSD build improvements added as requested
The addition of FreeBSD build improvements aligns with the PR objectives.
🧰 Tools
🪛 Markdownlint (0.37.0)
90-90: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
156-156: LGTM: Fork naming corrected from MN_R to MN_RR
The fork naming has been corrected as mentioned in the PR objectives.
🧰 Tools
🪛 Markdownlint (0.37.0)
156-156: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
92-92: Verify removal of quorum platformsign from v22 release notes
The PR objectives mention removing quorum platformsign from v22 release notes since it was introduced in v21. Let's verify this change has been made correctly.
✅ Verification successful
quorum platformsign has been correctly removed from v22 release notes
The verification confirms that:
quorum platformsignis not present in v22 release notes (doc/release-notes.md)- It is properly documented in v21 release notes where it was originally introduced
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that `quorum platformsign` is not mentioned in v22 release notes
# and is properly documented in v21 release notes
# Check v22 release notes (current file) for any mentions
echo "Checking v22.0.0 release notes for 'quorum platformsign'..."
rg -i "quorum platformsign" doc/release-notes.md
# Check v21 release notes for proper documentation
echo "Checking v21.0.0 release notes..."
rg -i "quorum platformsign" doc/release-notes/dash/release-notes-21.0.0.md
Length of output: 550
Issue being fixed or feature implemented
I noticed that we announced in current release new RPC
quorum platformsignwhich has been actually released with v21.Though, in release notes for v21 it has a wrong name.
What was done?
Removed
quorum platformsignfrom v22 release notes; fixed name in v21.Also mentioned build for Freebsd and minor typo
s/MN_R/MN_RR/with name of forks on regtest.How Has This Been Tested?
N/A
Breaking Changes
N/A
Checklist: