-
Notifications
You must be signed in to change notification settings - Fork 918
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
docs: Add share p2p documentation #2008
Conversation
@renaynay on a quick glance are these docs still representative of what they document? if so, I'll take this over and try and bring it home |
@derrandz if you fix these too long line lint errors quickly i'll merge this. otherwise i'll close out and ill add more documentation as we get closer to mainnet in coming month |
Cool, will fix and let's merge |
@ramin made a few corrections to the docs and made the linter happy. Should be ready to go |
Codecov Report
@@ Coverage Diff @@
## main #2008 +/- ##
==========================================
+ Coverage 51.51% 51.59% +0.08%
==========================================
Files 162 163 +1
Lines 10755 10784 +29
==========================================
+ Hits 5540 5564 +24
- Misses 4734 4742 +8
+ Partials 481 478 -3
|
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 good
Let's merge this and we can make edits as necessary to the contents, this PR is getting stale |
## Overview Self-explanatory ## How to Test Changes Launch: ``` $ godoc -http=:6060 ``` And browse the impacted packages. ## Checklist - [x] New and updated code has appropriate documentation - [x] New and updated code has new and/or updated testing - [x] Required CI checks are passing - [x] Visual proof for any user facing features like CLI or documentation updates - [x] Linked issues closed with keywords --------- Co-authored-by: ramin <raminkeene@gmail.com> Co-authored-by: Ryan <ryan@celestia.org>
Overview
Self-explanatory
How to Test Changes
Launch:
And browse the impacted packages.
Checklist