doc: document p2p package

[derrandz]

Overview

This PR documents peer usage throughout the go-header package, as well as it ships documentation for the p2p package and the sync package.

Run:

$ godoc -http=:6060

To visualize the documentation.

References

This PR is part of celestiaorg/celestia-node#1851 efforts

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

[codecov-commenter]

Codecov Report

Merging #17 (4fbb9b8) into main (1d06b1b) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #17      +/-   ##
==========================================
- Coverage   65.48%   65.45%   -0.03%     
==========================================
  Files          33       33              
  Lines        2764     2762       -2     
==========================================
- Hits         1810     1808       -2     
  Misses        798      798              
  Partials      156      156              

Impacted Files	Coverage Δ
p2p/session.go	92.47% <100.00%> (-0.09%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.