libp2p / go-libp2p-core

Interfaces and abstractions that make up go-libp2p
Other
145 stars 75 forks source link

[docs] list of doc improvements #2

Open lanzafame opened 5 years ago

lanzafame commented 5 years ago

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

raulk commented 5 years ago

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

raulk commented 5 years ago

@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.