-
Notifications
You must be signed in to change notification settings - Fork 7
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
Research - Code Documentation Tools #5
Labels
Comments
jamescd18
added
documentation
Improvements or additions to documentation
approved
labels
Feb 11, 2021
anthonybernardi
transferred this issue from Northeastern-Electric-Racing/PM-Dashboard-v2
Aug 11, 2022
this ticket is too vague and also not really needed -- if anything we hsould just add jsdoc everywhere and maybe some github docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
With the increasing complexity of the application and its code base, it's more important than ever to keep the code documentation up to date and readable. When doing this for a recent issue, I stumbled across this article about documentation for React components. That lead me to wonder what sort of tools might be out there to help us build user friendly documentation from code files and JSDoc. I know Storybook is a great thing that contrasts Angular Playground, so those are good things to peek at.
--
The text was updated successfully, but these errors were encountered: