search

waku-org / js-waku

JavaScript implementation of Waku v2
https://js.waku.org
Apache License 2.0
166 stars 42 forks source link

Explain behavior in code documentation #193

Open D4nte opened 3 years ago

D4nte commented 3 years ago

Problem

Some code comments may rely too much on knowledge of the protocol specs. Developers tend to not check protocol specs unless tackling very specific scenarios.

Solution

Explain behaviour and usage of the API from a dApp dev point of view.

D4nte commented 2 years ago

@jemboh: what are your thoughts on the matter as you have been playing around with the library? I believe the docs are better now and assume less knowledge of the specs from the dev.

fryorcraken commented 2 years ago

I would suggest to park this one for now and focus on getting waku.guide up and running first. Then it makes it easy to include guide link in the docs.