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

Implement viewable documentation #10

Open
0xJem opened this issue Jun 7, 2022 · 0 comments
Open

Implement viewable documentation #10

0xJem opened this issue Jun 7, 2022 · 0 comments

Comments

@0xJem
Copy link
Collaborator

0xJem commented Jun 7, 2022

There is now extensive documentation in the codebase, which should help non-technical people to understand how the metrics are calculated. Documentation should be automatically generated and hosted, so that it can be reviewed.

JSDoc is an option, and seems to also support linking between functions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@0xJem