Skip to content
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] Update the learning guide #439

Merged
merged 10 commits into from
Jan 18, 2023

Conversation

Olshansk
Copy link
Member

Description

Update the learning guide used for onboarding new internal & external contributors.

Issue

NA

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

  • Add direct links to the docs describing each of the V1 modules
  • Link to Otto's V0 guide to Pocket
  • Link to the V0 Claim & Proof lifecycle
  • Add a link to [@https://twitter.com/ittaia]'s Decentralized Thoughts newsletter
  • Add link to a good and simple blog on kademlia

Testing

NA

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Jan 16, 2023
@Olshansk Olshansk self-assigned this Jan 16, 2023
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed a small typo but otherwise this looks great and I'm looking forward to reading it - thanks @Olshansk, just in time! 😄

Co-authored-by: Bryan White <[email protected]>
@Olshansk
Copy link
Member Author

Thanks for the quick review @bryanchriswhite! If you can think of any ways to improve/clarify it as you make your way through the doc, don't hesitate to change it.

Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌

@Olshansk Olshansk merged commit 8c053e9 into main Jan 18, 2023
@Olshansk Olshansk deleted the docs/add_link_to_learning_guide branch January 18, 2023 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants