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

Research - Code Documentation Tools #5

Closed
6 tasks
jamescd18 opened this issue Feb 11, 2021 · 1 comment
Closed
6 tasks

Research - Code Documentation Tools #5

jamescd18 opened this issue Feb 11, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation medium spike Research

Comments

@jamescd18
Copy link
Member

jamescd18 commented Feb 11, 2021

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.

--

  • Read the styleguidist article on documenting React components
  • Research common practices for documentation of React components
  • Read about Storybook
  • Read about Angular Playground (just for awareness)
  • Research more about Storybook
  • Summarize your findings and offer a suggestion
@jamescd18 jamescd18 added documentation Improvements or additions to documentation approved labels Feb 11, 2021
@jamescd18 jamescd18 added the spike Research label Feb 21, 2022
@anthonybernardi anthonybernardi transferred this issue from Northeastern-Electric-Racing/PM-Dashboard-v2 Aug 11, 2022
@anthonybernardi
Copy link
Collaborator

this ticket is too vague and also not really needed -- if anything we hsould just add jsdoc everywhere and maybe some github docs

martin0he added a commit that referenced this issue Nov 11, 2023
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 medium spike Research
Projects
None yet
Development

No branches or pull requests

3 participants