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

documentation with tsdoc? #157

Open

illume opened this issue Jan 11, 2024 · 1 comment

Collaborator

illume commented Jan 11, 2024

It seems we need to add documentation to a lot of the new app code.

The https://tsdoc.org/ website shows examples of how to document code with TypeScript.

Note, that storybook stories additionally is documentation for components. It uses the tsdoc comments when viewing components as well.

illume changed the title ~~documentation with tsdoc~~ documentation with tsdoc?

Collaborator

justinpac commented Jan 14, 2024

This is a great suggestion! I agree we need to get better about documentation moving forward. @siddheshraze what do you think?

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