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

Add automated JSDoc documentation generation #47

Merged
merged 3 commits into from
Apr 23, 2023
Merged

Conversation

frankhinek
Copy link
Contributor

@frankhinek frankhinek commented Apr 23, 2023

What's Changed?

  • Adds JSDoc configuration file jsdoc.json.
  • Fixes JSDoc syntax errors that caused JSDoc doc generation to fail (src/did/connect/ws-client.js, src/types.js).
  • Adds minimal docs to src/web5.js and src/did/connect/ws-client.js as an example.
  • Adds GitHub Actions workflow Build and Deploy Docs to automate publishing docs to https://tbd54566975.github.io/web5-js/.
  • Resolves Need API reference for web5.js - JSDoc #34

@frankhinek frankhinek added the documentation Improvements or additions to documentation label Apr 23, 2023
@frankhinek frankhinek requested a review from csuwildcat April 23, 2023 12:36
@frankhinek frankhinek self-assigned this Apr 23, 2023
@csuwildcat csuwildcat merged commit ee0107c into main Apr 23, 2023
@frankhinek frankhinek deleted the docs/autogenerate branch April 23, 2023 12:46
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
None yet
Development

Successfully merging this pull request may close these issues.

Need API reference for web5.js - JSDoc
2 participants