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.

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

Minor fixes in UG & DG #346

Merged
merged 24 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
238 changes: 155 additions & 83 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

20 changes: 13 additions & 7 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ Clients with **NA** status (no follow-up required) have no status label on the U
[↑ Return to Table of Contents](#table-of-contents)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

# 4. Glossary
This section contains a list of terms used in this user guide. Feel free to refer back to this section if you are unsure of what a term means!
Expand Down Expand Up @@ -263,13 +264,14 @@ Let's take a look at the structure in more detail:
| **Flag(s)** | Modifiers that specify what kind of data is being handled. <br/><br/>Flag(s) are typically 1-2 letters followed by a backslash. | `n/`, `e/`, `r/`, `rn/` |
| **Argument(s)** | The values or inputs the command uses, such as client data or specific details. <br><br> This guide may represent it as a placeholder using `<ARGUMENT>`. | `John Doe`, `[email protected]` |

Here's an example that uses multiple flags and arguments:
Here's a snippet of a command that uses multiple flags and arguments:
```
add n/ John Doe e/ [email protected]
```
* **Command:** `add` instructs AgentAssist to add a new entry.
* **Flags:** `n/` and `e/` specify the information type (name and email).
* **Arguments:** `John Doe` and `[email protected]` are the actual values being input for the respective flags.
* **Note:** This command is provided as an example for learning purposes only. Additional mandatory flags are needed to make it fully functional, which will be explained in the sections that follow.

<div style="page-break-after: always;"></div>

Expand Down Expand Up @@ -408,13 +410,17 @@ Some initial commands to try:

The GUI will dynamically update to show the results of your commands, making it easy to see the impact of your actions in real time.

**Note:** The order of flags is flexible. For instance, edit 1 n/ john p/ 92223333 is equivalent to edit 1 p/ 92223333 n/ john.

Refer to the [Commands Section](#6-commands) for more comprehensive details of each command.

> 💡 **Pro Tip:**
>
> Combine commands like `filter` followed by `edit` or `delete` to manage your contacts more effectively.
> - The order of flags within commands is flexible. For instance, `edit 1 n/ john p/ 92223333` is equivalent to `edit 1 p/ 92223333 n/ john`. Use whatever order feels most natural!
>
> - Combine commands like `filter` followed by `edit` or `delete` to manage your contacts more effectively.
>
> For example, use `filter j/ doctor` to display all doctors, then `edit 2 a/ 321 New Address` to update the address for the second listed doctor.
> - For example, use `filter j/ doctor` to display all doctors, then `edit 2 a/ 321 New Address` to update the address for the second listed doctor.

[↑ Return to Table of Contents](#table-of-contents)

Expand Down Expand Up @@ -849,11 +855,11 @@ view <INDEX>
- The images below show the GUI before and after using `view 1`:
<div style="display: flex; gap: 10px;">
<figure markdown>
<img src="images/UIBeforeView.png" alt="UI Before View" style="width: 100%;">
<img src="images/UIBeforeView.png" alt="UI Before View" style="width: 300;">
<figcaption>Before View</figcaption>
</figure>
<figure markdown>
<img src="images/UIAfterView.png" alt="UI After View" style="width: 100%;">
<img src="images/UIAfterView.png" alt="UI After View" style="width: 300;">
<figcaption>After View</figcaption>
</figure>
</div>
Expand Down Expand Up @@ -892,11 +898,11 @@ close
- The images below show the GUI before and after using `close`:
<div style="display: flex; gap: 10px;">
<figure markdown>
<img src="images/UIAfterView.png" alt="UI Before View" style="width: 100%;">
<img src="images/UIAfterView.png" alt="UI Before View" style="width: 300;">
<figcaption>Before Close</figcaption>
</figure>
<figure markdown>
<img src="images/UIAfterClose.png" alt="UI After View" style="width: 100%;">
<img src="images/UIAfterClose.png" alt="UI After View" style="width: 300;">
<figcaption>After Close</figcaption>
</figure>
</div>
Expand Down
7 changes: 5 additions & 2 deletions docs/diagrams/AddActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ start

if () then ([mandatory flags are all present
and no invalid flag is used])
:Tokenize arguments;
if () then ([All flag values are valid])
:Check database of existing clients;
if () then ([No existing client with identical name,
phone number, and email])
:New client with specified details is added;
Expand All @@ -19,8 +21,9 @@ and no invalid flag is used])
not met its respective requirement;
endif
else ([else])
:Show error message stating which flags are missing;
:Show error message stating
which flags are missing;
endif

stop
@enduml
@enduml
24 changes: 13 additions & 11 deletions docs/diagrams/EditActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
@startuml
sprite $rake [16x16/8] {
0000000000000000
0000000jj0000000
0000000jj0000000
0005555jj5555000
000jjeejjeejj000
000jj00jj00jj000
000jj00jj00jj000
0000000000000000
}
title Edit Activity Diagram
start
:Edit command is given;
if () then ([Index provided is positive])
:Tokenize arguments;
if () then ([At least one flag is specified ])
if () then (['remark new' and 'remark append' flags
are not used simultaneously])
if () then ([Values for specified flags are all valid])
if () then ([Index provided is within range])
:Edit client pertaining to given index;
else ([else])
:Show error message that the specified index is out of range;
endif
else ([else])
:Show error message stating
which flags have wrong values;
endif
:Perform flag values check <$rake>;
else ([else])
:Show error message that 'remark new' and 'remark append'
flags cannot be used together;
Expand All @@ -29,4 +31,4 @@ else ([else])
is of an invalid format;
endif
stop
@enduml
@enduml
19 changes: 19 additions & 0 deletions docs/diagrams/EditActivityDiagramFlagCheck.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
@startuml
'https://plantuml.com/activity-diagram-beta
title Edit Activity Diagram (Perform flag values check)
start
if () then ([Values for specified flags are all valid])
:Check if index is within range of currently displayed list;
if () then ([Index provided is within range])
:Edit client pertaining to given index;
else ([else])
:Show error message that the specified index is out of range;
endif
else ([else])
:Show error message stating
which flags have wrong values;
endif

stop

@enduml
Binary file modified docs/images/AddActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/EditActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EditActivityDiagramFlagCheck.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/HelpWindow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading