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.

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

feat: setup jsdoc for documentation #58

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

feat: setup jsdoc for documentation #58

wants to merge 5 commits into from

Conversation

Samridhi-98
Copy link

Description

  • Added conf.json
  • Modified package.json

Resolves
Fixes #17

@Samridhi-98
Copy link
Author

@coditva @elit-altum please review my PR.

coditva
coditva requested changes Feb 14, 2022
View reviewed changes
Copy link
Member

@coditva coditva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Samridhi-98 We might need to add JSDoc to the three sub-packages dashboard, frontend and reporter

package.json Outdated Show resolved Hide resolved
conf.json Outdated Show resolved Hide resolved
@Samridhi-98
Copy link
Author

@Samridhi-98 We might need to add JSDoc to the three sub-packages dashboard, frontend and reporter

I have updated the package.json script for each subdirectory keeping jsdoc.conf.json the same for all.
Please review and let me know if I have implemented it correctly or not.

coditva
coditva reviewed Feb 14, 2022
View reviewed changes
Copy link
Member

@coditva coditva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As next steps after this PR is merged, we can think about integrating the docs with the CI and maybe hosting them on GitHub Pages or something. 🤔

dashboard/package.json Outdated Show resolved Hide resolved
dashboard/package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
coditva
coditva reviewed Feb 14, 2022
View reviewed changes
dashboard/package.json Outdated Show resolved Hide resolved
jsdoc.conf.json Outdated Show resolved Hide resolved
jsdoc.conf.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coditva coditva Awaiting requested review from coditva

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Setup JSDoc to generate documentation
2 participants
@Samridhi-98 @coditva