docs: complete release scripts documentation in README #1365
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
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.
Motivation:
There was a TODO in README.md. This documentation gap may make it difficult for new contributors to understand how scripts are broken into multiple steps for managing protocol releases.
Modifications:
Completed the "Writing a Script" section by adding detailed explanation of the three types of script steps (Deployment, Queue, and Execution) and how they should be executed in sequence.
Result:
Improved documentation that clearly explains the script structure and execution flow. New contributors will better understand how to create and manage release scripts using the Zeus framework.