-
Notifications
You must be signed in to change notification settings - Fork 33
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
[Documentation] Updated the new contributor learning guide #305
Conversation
cc @ArtSabintsev as well |
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.
Please check the highlighted parts
@Jasonyou1995 Love all of the suggestions you made and pushed the corresponding changes! Please take another look when you have a chance again |
@Jasonyou1995 Please review again when you have a chance. Would appreciate your input here. |
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.
I added some more review comments for more readability, please see the high lights.
docs/learning/README.md
Outdated
- [Utility](https://docs.google.com/presentation/d/1NU0PnegtBm5ioLu0VQMiluWT4usHnavDKrGvS3p8QdM/edit) | ||
- [Persistence](https://docs.google.com/presentation/d/1qDA-pRMT1KV9byUAU49bvd_5seaILPAh6i3vA7j5l8o/edit) | ||
- [P2p](https://docs.google.com/presentation/d/1CLeAcGJbM_iP76vnCoHreU1chB9vFWIYWAwQHa-MPbc/edit) | ||
- [Consensus](https://docs.google.com/presentation/d/18CtSxxLLHY1N7HEJtja633mVF1_a9blaE2fe2-WgGAo/edit) | ||
--> |
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.
Here is a just my thoughts for a more intuitive structure: (might require restructuring and analyzing which existing/listed contents mainly belong to which)
- Utility
Technical content 1 (related to utility)
Technical content 2
- Persistence
Technical content 1 (related to persistence)
Technical content 2
- P2P
Technical content 1 (related to P2P)
Technical content 2
- Consensus
Technical content 1 (related to Consensus)
Technical content 2
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.
Note that these are hidden (they're inside of comments) and not actually rendered on the README.
Otherwise, I'm not quite sure what the suggestion is. Where to Start?
is meant to be a set of steps someone follows rather than a link dump of rerences.
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.
Very nice!
Damn it tho... how do I not click onto something I was told not to click on? (referring to non-suggested reads
) 😁
Going to merge this in and we can iterate further if/when need be. |
@deblasis Noted. Good lesson in getting people to do stuff. Message to the community: w/e you do, make sure not to contribute to V1. |
Description
Improve the new-contributor learning-guide with the new links, better formatting and a technical foundation section. See the full list of changes below.
Issue
NA
Type of change
Please mark the relevant option(s):
List of changes
Made several modifications to
docs/learning/README.md
Testing
make develop_test
README
Required Checklist
If Applicable Checklist
shared/docs/*
if I updatedshared/*
README(s)