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

compile docs from jsdoc #89

Open
samuelstroschein opened this issue Oct 15, 2024 — with Linear · 1 comment
Open

compile docs from jsdoc #89

samuelstroschein opened this issue Oct 15, 2024 — with Linear · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

Copy link
Member

Context

We can compile a reference documentation via https://typedoc.org/.

Proposal

Implement https://typedoc.org/ for the lix SDK.

  • only have to write reference documentation once
  • nudges us to write good jsdoc
@samuelstroschein samuelstroschein added the documentation Improvements or additions to documentation label Oct 15, 2024 — with Linear
Copy link
Member Author

@felix.haeberle is this task something you are interested in ?>

  • contributing to the docs as starting point to go deeper into lix

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

No branches or pull requests

1 participant