Added UserGuide template and filled in some information #30
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
Pull Request Test Coverage Report for Build 11278019247Details
💛 - Coveralls |
KesterTan
approved these changes
Oct 10, 2024
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.
This PR introduces the UserGuide.md document in our root directory that we are expected to have for project 2C. This UserGuide is supposed to detail how to use our new features and what testing we have in place that ensures it properly works.
I added context above the feature descriptions giving a high-level summary of the changes we made, and I filled in the search bar details that I could already. I gave an example template of what we still need to fill out.
By the end of today, we need to have this document fully written out. Feel free to edit anything I already wrote in the document.