Skip to content

Commit

Permalink
Merge pull request #370 from JoanneHing/user-guide
Browse files Browse the repository at this point in the history
User guide
  • Loading branch information
JoanneHing authored Nov 12, 2024
2 parents 24d7a47 + 43c59ce commit 7f7cc1f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).
:bulb: **Tip:** The `.puml` files used to create diagrams in this document `docs/diagrams` folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html) to learn how to create and edit diagrams.
</div>

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

### Architecture

<img src="images/ArchitectureDiagram.png" width="280" />
Expand Down
6 changes: 6 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,8 @@ Examples:

![Delete Success Message](images/delete.png)

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

### Editing a student : `edit`

Edits an existing student's details in the system.
Expand Down Expand Up @@ -424,6 +426,8 @@ For example, if the student is taking English and Math and you use the command '
only be taking Science.
</div>

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

### Listing all students : `list`

Shows a list of all students in the system.
Expand All @@ -450,6 +454,8 @@ Examples:

![Detail Success Message](images/detail.png)

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

## Searching and Sorting
<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
All the following commands will update the list of students shown in the main window.
Expand Down

0 comments on commit 7f7cc1f

Please sign in to comment.