-
Notifications
You must be signed in to change notification settings - Fork 111
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
Various improvements to demo-rollup/README.md
#477
Merged
Merged
Conversation
This file contains 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
bkolad
approved these changes
Jul 7, 2023
cemozerr
approved these changes
Jul 7, 2023
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.
Looks great! Great formatting.
neysofu
force-pushed
the
filippo/demo-rollup-improvs
branch
from
July 7, 2023 14:21
c19c9df
to
e273ab9
Compare
This reverts commit 041360e.
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.
Description
This is an attempt at making
examples/demo-rollup/README.md
more pleasing to the eye, simpler to follow, and overall better. Follow-up to #448.Before: https://github.com/Sovereign-Labs/sovereign-sdk/blob/main/examples/demo-rollup/README.md
After: https://github.com/Sovereign-Labs/sovereign-sdk/blob/filippo/demo-rollup-improvs/examples/demo-rollup/README.md
Most notable changes:
Linked Issues
This PR is not a solution to #476, which requires some deeper contents changes.
Testing
After modifying the README, I manually followed the process multiple time, also attempting slight variations and deviations. I believe it's working identical as before, as I haven't really changed the code blocks. Still, it would be great if someone else checked.
I recognize the Table of Contents can be a bit of a pain point, I wouldn't want anybody to forget to update it when modifying the README. We can either:
doctoc
and diffing the file). 👈 EDIT: this is what I ended up doing.stable
release checklist.I'm interested in feedback on these options.