docs: finalize SSZ usage documentation for TypeScript devs (Issue #5045) #8078
+1,513
−0
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
…older structure and markdown files to document SSZ types and utilities. This will serve as a reference for contributors and developers working with Lodestar’s SSZ types
|
|
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
lolosaisa
changed the title
…oofs.md on the readme file
lolosaisa
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## unstable #8078 +/- ##
============================================
- Coverage 55.72% 52.19% -3.53%
============================================
Files 834 852 +18
Lines 59754 65054 +5300
Branches 4611 4773 +162
============================================
+ Hits 33299 33958 +659
- Misses 26386 31027 +4641
Partials 69 69 🚀 New features to boost your workflow:
|
…d what they represent
… want to learn more
…as and made a few changes on the styling and arrangement of the docs
…at it is and when is it useful
… real life example and defination of attestation
…fety is implemented and why it matters in the Ethereum Development
…section and the simple definations
…e it to actually happen
…ning from one topic to the other easier
… then polished a few things
…les decided to make the example.md file Having one centralized examples file makes it easy for developers
…pts that are being demonstrated
lolosaisa
changed the title
|
This PR completes the SSZ documentation targeted at TypeScript developers. What's New
|
lolosaisa
changed the title
|
Please lint your work @lolosaisa and thoroughly read the contributor's document to help make CI pass before review, thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds a rough structure for the SSZ documentation targeted at TypeScript developers, in reference to #5045.
What's included
/packages/types/docs/directory to hold new SSZ usage documentationssz-quickstart.md– Quickstart on serialize/deserialize/hashTreeRootssz-views-and-proofs.md– Overview of views and merkle proofsphase0/Attestation.md,BeaconBlock.md,Validator.mdaltair/SyncCommittee.mdbellatrix/ExecutionPayload.mdREADME.mdoutlining the purpose and structure of the documentationPurpose
This PR is intended to: