go-libp2p-core icon indicating copy to clipboard operation
go-libp2p-core copied to clipboard

Published 20 hours ago • verified publisher icon libp2p

[docs] list of doc improvements

Open lanzafame opened this issue 6 years ago • 2 comments

List of doc improvements mentioned in #1 that will potentially (linking so they don't get lost) get incorporated into the next iteration:

  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276048081
  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276049519
  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276052657
  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276055055
  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276055848
  • https://github.com/libp2p/go-libp2p-core/pull/1#pullrequestreview-227512419
  • https://github.com/libp2p/go-libp2p-core/pull/1/files#r276497226

lanzafame avatar Apr 18 '19 01:04 lanzafame

@yusefnapora let's tag-team on this, if you have cycles.

raulk avatar Apr 18 '19 10:04 raulk

@lanzafame is enumerating a few places where clarifications are needed. But the goal is larger. Rewriting all godocs is on the table. We want excellent, intuitive, clear, precise godocs that minimise the need to rely on external docs.

raulk avatar Apr 18 '19 10:04 raulk