docs: Add environment documentation link and description (backport #23330) #23337
+1
−1
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.
Closes: #XXXX (Note: Since we don't have a specific issue number, this would be filled with actual issue number if exists)
This PR improves the documentation in UPGRADING.md by replacing a TODO placeholder with comprehensive documentation about the Environment struct and its services. The changes include:
This PR adds proper documentation for the Environment struct in the
UPGRADING.md file, replacing a TODO placeholder. The added documentation
helps developers understand the essential services provided to modules
through the Environment struct, including logging, event handling,
gas metering, header access, routing, and store services.
This documentation helps developers better understand the module environment system when upgrading their applications to the latest version.
The change improves developer experience by providing clear information about the module environment system directly in the upgrade guide, making it easier for developers to understand and implement the necessary changes during upgrades.
!
in the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
Release Notes
This PR adds proper documentation for the Environment struct in the
UPGRADING.md file, replacing a TODO placeholder. The added documentation
helps developers understand the essential services provided to modules
through the Environment struct, including logging, event handling,
gas metering, header access, routing, and store services.
Summary by CodeRabbit
Release Notes
Breaking Changes
x/params
modulex/crisis
moduleNew Features
x/protocolpool
modulex/validate
moduleSignMode Textual
featureMigration Guidance
Developers should carefully review the upgrading documentation for detailed migration instructions.
This is an automatic backport of pull request #23330 done by [Mergify](https://mergify.com).