Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain behavior in code documentation #193

Open
D4nte opened this issue Jun 4, 2021 · 2 comments
Open

Explain behavior in code documentation #193

D4nte opened this issue Jun 4, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation
Projects

Comments

@D4nte
Copy link
Contributor

D4nte commented Jun 4, 2021

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 D4nte created this issue from a note in js-waku (New) Jun 4, 2021
@D4nte D4nte moved this from New to Backlog in js-waku Jun 7, 2021
@D4nte D4nte added this to the Developer Ready milestone Jul 15, 2021
@D4nte D4nte added the documentation Improvements or additions to documentation label Jul 15, 2021
@D4nte
Copy link
Contributor Author

D4nte commented Feb 11, 2022

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

@D4nte D4nte moved this from Backlog to Backlog (groomed) in js-waku Feb 21, 2022
@fryorcraken
Copy link
Collaborator

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.

@fryorcraken fryorcraken moved this from Backlog to Moved to Waku Product Project in js-waku Aug 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Icebox
js-waku
Moved to Waku Product Project
Development

No branches or pull requests

2 participants