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

docs: Add share p2p documentation #2008

Merged
merged 12 commits into from
Sep 20, 2023

Conversation

derrandz
Copy link
Contributor

@derrandz derrandz commented Apr 4, 2023

Overview

Self-explanatory

How to Test Changes

Launch:

$ godoc -http=:6060

And browse the impacted packages.

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@derrandz derrandz added the kind:misc Attached to miscellaneous PRs label Apr 4, 2023
@derrandz derrandz marked this pull request as ready for review April 4, 2023 00:37
@renaynay renaynay changed the title Docs: share p2p documentation docs: Add share p2p documentation Apr 4, 2023
@ramin
Copy link
Contributor

ramin commented Sep 5, 2023

@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

@ramin ramin self-assigned this Sep 5, 2023
@derrandz
Copy link
Contributor Author

derrandz commented Sep 5, 2023

HI @ramin these docs should still be accurate, but would require updates once #2604 is closed as well after all of the pruning and sharding logic happens as it will impact peer manager full nodes discovery and should be documented then.

@ramin
Copy link
Contributor

ramin commented Sep 7, 2023

@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

@derrandz
Copy link
Contributor Author

derrandz commented Sep 7, 2023

Cool, will fix and let's merge

@derrandz
Copy link
Contributor Author

derrandz commented Sep 8, 2023

@ramin made a few corrections to the docs and made the linter happy. Should be ready to go

@codecov-commenter
Copy link

codecov-commenter commented Sep 13, 2023

Codecov Report

Merging #2008 (b9460b6) into main (fd90764) will increase coverage by 0.08%.
Report is 5 commits behind head on main.
The diff coverage is 38.29%.

@@            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     
Files Changed Coverage Δ
blob/service.go 69.41% <ø> (+1.17%) ⬆️
share/eds/cache/doublecache.go 0.00% <0.00%> (ø)
share/eds/store.go 69.13% <57.14%> (-0.45%) ⬇️
share/eds/utils.go 66.66% <75.00%> (-11.91%) ⬇️
share/eds/blockstore.go 38.70% <100.00%> (+1.20%) ⬆️

... and 4 files with indirect coverage changes

cmd/celestia/rpc.go Outdated Show resolved Hide resolved
@derrandz derrandz requested a review from ramin September 19, 2023 07:33
Copy link
Contributor

@ramin ramin left a comment

Choose a reason for hiding this comment

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

looks good

@distractedm1nd
Copy link
Member

Let's merge this and we can make edits as necessary to the contents, this PR is getting stale

@distractedm1nd distractedm1nd merged commit 591bc42 into celestiaorg:main Sep 20, 2023
12 of 14 checks passed
vgonkivs pushed a commit to vgonkivs/celestia-node that referenced this pull request Oct 5, 2023
## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:docs For solely documentation PRs kind:misc Attached to miscellaneous PRs
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants