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.

Sign up for GitHub

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

Jump to bottom

chore: add documentation #4

Open
4 tasks
richard-ramos opened this issue Nov 15, 2022 · 0 comments
Open
4 tasks

chore: add documentation #4

richard-ramos opened this issue Nov 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@richard-ramos
Copy link
Member

richard-ramos commented Nov 15, 2022 •
edited by fryorcraken
Loading

Problem

No API documentation available

Acceptance Criteria

  • Setup typedoc to generate documentation
  • Get the generated documentation hosted somewhere
  • Document functions/classes/etc that developers are expected to use
  • Provide quick start doc in waku.guide, similar to what is done in the README.md file

Note

We do have an example using the noise library
@fryorcraken fryorcraken added this to Waku Nov 15, 2022
@fryorcraken fryorcraken moved this to Triage in Waku Feb 22, 2023
@fryorcraken fryorcraken added the documentation Improvements or additions to documentation label Mar 23, 2023
@fryorcraken fryorcraken moved this from Triage to To Do in Waku Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Waku
Status: To Do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@richard-ramos @fryorcraken