feat: Improve README.md structure #323
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
Closed
ata-nas
reviewed
Oct 29, 2024
ata-nas
force-pushed
the
320-reorganize-readmemd
branch
from
0644e6d to
dcca6b2
Compare
ata-nas
force-pushed
the
320-reorganize-readmemd
branch
from
81452bb to
03bdb3f
Compare
There was a problem hiding this comment.
Some formatting comments.
Content seems reasonable.
One general comment:
Some files use horizontal rules (--- alone in markdown) before each header. It is entirely a matter of opinion, but I find that these tend to break up the text quite a bit more than necessary and it might be better to remove those.
Signed-off-by: georgi-l95 <[email protected]>
Signed-off-by: georgi-l95 <[email protected]>
…to finish for others Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
Signed-off-by: Atanas Atanasov <[email protected]>
ata-nas
force-pushed
the
320-reorganize-readmemd
branch
from
2628530 to
3324c4d
Compare
jsync-swirlds
approved these changes
Nov 7, 2024
rbarkerSL
approved these changes
Nov 8, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #323 +/- ##
=========================================
Coverage 98.48% 98.48%
Complexity 294 294
=========================================
Files 63 63
Lines 1119 1119
Branches 79 79
=========================================
Hits 1102 1102
Misses 11 11
Partials 6 6 |
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 PR aims to improve the README.md structure and make it easier for new user and contributors to find their way around.
NOTES:
Related issue(s):
Fixes #320
Fixes #263
Fixes #325
Notes for reviewer:
Checklist