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

[Feature] Publish typedoc docs #430

Open
2 of 6 tasks
huntharo opened this issue May 22, 2024 · 0 comments · May be fixed by #432
Open
2 of 6 tasks

[Feature] Publish typedoc docs #430

huntharo opened this issue May 22, 2024 · 0 comments · May be fixed by #432

Comments

@huntharo
Copy link
Contributor

huntharo commented May 22, 2024

Is your feature request related to a problem? Please describe.

  • Publish the jsdoc / typedoc comments as docs on GitHub pages

Describe the solution you'd like

  • Add typedoc dep
  • Add a GitHub Actions workflow to generate the docs on main and publish them to GitHub pages
  • Update the URL for the project on GitHub repo settings to point to the GitHub Pages for the project
  • Figure out what to do with existing API.md
    • Should we incorporate the code examples into the jsdoc docs?
    • Should we remove this?

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant