Clear release notes #168
Closed
Clear release notes #168
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Florian Wagner <florian.wagner@frequenz.com>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR updates the RELEASE_NOTES.md file to remove outdated text and insert placeholder comments for upgrade instructions, new features, and bug fixes.
- Replaces specific release note details with HTML comment placeholders in the "Upgrading", "New Features", and "Bug Fixes" sections.
Comments suppressed due to low confidence (3)
RELEASE_NOTES.md:9
- The placeholder in the 'Upgrading' section should be replaced with detailed upgrade instructions before merging to improve clarity for users.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
RELEASE_NOTES.md:13
- Provide concrete descriptions and examples for the new features rather than placeholder comments to ensure users understand the improvements.
<!-- Here goes the main new features and examples or instructions on how to use them -->
RELEASE_NOTES.md:17
- Ensure the 'Bug Fixes' section includes clear, detailed explanations of each fix before finalizing the release notes.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
llucax
approved these changes
Jun 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.