Improving Waku documentation

Thanks for starting this discussion @sergei-tikhomirov.

Some thoughts I have specifically regarding another “audience” type for the documentation:

Some developer wants to implement a peer 2 peer communication application (for whatever reason).
They start by searching for key terms e.g. “peer 2 peer communication tools/library/implementation”

  1. How do we get waku at the top results for searches like this?

Then, let’s say the developer somehow gets to the waku webpage (https://waku.org).
They are interested in implementation, where do they start, the “Get involved” button is ambiguous.
They mainly want to know how to install and how to get started.
Ideally that would mean something like an npm install command and then example code. Neither of which is obvious to navigate to from the homepage.

By comparison, the https://libp2p.io/ website is much more intuitive.
It could also help to explain why you would use waku instead of libp2p (or other similar tools).

3 Likes