-
Notifications
You must be signed in to change notification settings - Fork 108
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: changelog for v23 #3190
docs: changelog for v23 #3190
Conversation
📝 WalkthroughWalkthroughThe pull request updates the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
changelog.md (2)
Line range hint
3-40
: Ensure consistent formatting in version 23.0.0 section.The changelog entries are well-organized by category, but there are some inconsistencies in the formatting:
- Some entries use bullet points with asterisks (*) while others use dashes (-)
- Some PR links are wrapped in square brackets while others aren't
Apply consistent formatting throughout:
### Features - [2984](https://github.com/zeta-chain/node/pull/2984) - add Whitelist message ability to whitelist SPL tokens on Solana - [3091](https://github.com/zeta-chain/node/pull/3091) - improve build reproducability. `make release{,-build-only}` checksums should now be stable. - [3124](https://github.com/zeta-chain/node/pull/3124) - integrate SPL deposits
41-81
: Consolidate duplicate section headings.There are multiple instances of duplicate section headings (e.g., "Fixes") across different versions. While this is common in changelogs, consider using subsection markers or version-specific prefixes for better navigation.
Consider restructuring sections to avoid duplicate headings:
## v22.1.2 ### v22.1.2 Fixes - [3181] - add lock around pingRTT to prevent crash ## v22.1.1 ### v22.1.1 Fixes - [3171] - infinite discovery address leak🧰 Tools
🪛 Markdownlint (0.35.0)
45-45: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
51-51: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
57-57: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
61-61: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
62-62: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
68-68: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
74-74: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
49-49: null
Multiple headings with the same content(MD024, no-duplicate-heading)
59-59: null
Multiple headings with the same content(MD024, no-duplicate-heading)
66-66: null
Multiple headings with the same content(MD024, no-duplicate-heading)
72-72: null
Multiple headings with the same content(MD024, no-duplicate-heading)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
changelog.md
(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
changelog.md
45-45: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
51-51: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
57-57: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
61-61: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
62-62: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
68-68: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
74-74: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
49-49: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
59-59: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
66-66: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
72-72: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (1)
changelog.md (1)
Line range hint 1-81
: LGTM! The changelog is well-structured and informative.
The changelog effectively documents the changes across versions with:
- Clear version numbering
- Categorized changes (Features, Tests, Refactor, Fixes)
- PR references with links
- Concise descriptions of changes
🧰 Tools
🪛 Markdownlint (0.35.0)
45-45: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
51-51: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
57-57: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
61-61: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
62-62: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
68-68: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
74-74: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
49-49: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
59-59: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
66-66: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
72-72: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
Description
Update changelog for v23
Reorganize from previous fixes we make
Summary by CodeRabbit
New Features
zetaclient
pprof server on port 6061.Improvements
Bug Fixes
Documentation