Add auto-generated TypeDoc docs for frontend #74
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
archang19
changed the title
Ssirrikh
approved these changes
Feb 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can run
npm run docto generate docs inside thedocsfolder. These docs can be viewed as HTML files. One of the requirements of Part C is to have documentation that we can link in our report. We used Typedoc for the backend documentation so we are using it for frontend documentation as well.The files changed in this PR are mostly the autogenerated docs. I added comments above some of our components so that the HTML docs have some useful information in them (these are the only changes made to the
srcfolder). The comments in the HTML docs have links to other components which is quite nice.