Update user guide #384
Merged
Update user guide #384
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
Fix UG bugs
|
Thanks for fixing 👍 |
Asuraxsoul
reviewed
Nov 9, 2020
| @@ -177,8 +177,12 @@ this box. | |||
| #### 4.1.1 Top Bar | |||
| * The top bar includes the following components. | |||
| 1. Summary information - A quick summary indicating the number of ungraded `Missions` and `Quests`, upcoming | |||
| `Consultations` and `Mastery Checks` as well as outstanding `Tasks` in Jarvis. Do note that graded `Missions` and | |||
| `Consultations` and `Mastery Checks` as well as all `Tasks` in Jarvis. Do note that graded `Missions` and | |||
| `Quests`, as well as past `Consultations` and `Mastery Checks`, will not be indicated. | ||
|
|
||
| We refer to this summary as the `Summary` feature. The summary is presented as a sentence containing the | ||
| count of the fields stated in the previous paragraph, in the image above, it is the sentence "Remaining - Nothing!". The values are updated when Jarvis starts up and after a user command is entered. |
There was a problem hiding this comment.
thanks for adding such detailed explanation to summary feature
| ` will remain the same, even if | ||
| the current time has passed the date and time of a `Consultation` or `Mastery Check`. Also, if a `Mission` or | ||
| `Quest` is graded while Jarvis is open, the number of ungraded `Mission` and `Quests` will remain the same. | ||
| * To get the updated values, simply re-start Jarvis or type in a command and hit the enter key on your keyboard. |
There was a problem hiding this comment.
I feel that this bullet point under this section 6.1.5 is quite important. Maybe we can give a markdown box for caution?
There was a problem hiding this comment.
That is true, great suggestion! @peironggg could you help with this since you are working on the UG currently? thank you!
| An example of a partial match will be `view -s do` resulting in John Doe being displayed. | ||
| Shows all `Students` that match (partial and full) the name entered after the command. The name is case-sensitive | ||
| and partial name matches will work, the following is an example. If you would like to look for your student Tommy | ||
| Hilfiger, you can simply type in `view -s Tom` and the student will be displayed. A full match on the other hand would be as such: key in the command `view -s John Doe` and John |
There was a problem hiding this comment.
thanks for elaborating more about the example
| @@ -48,11 +48,11 @@ Given below are my contributions to the project. | |||
| * **Documentation**: | |||
| * User Guide: | |||
| * Created the first copy of the UserGuide in markdown format. [\#18](https://github.com/AY2021S1-CS2103T-W11-2/tp/pull/18) | |||
| * Added documentation for the features `view students` | |||
| * Added documentation for the features `View Students` | |||
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.
Fix UG bugs