Skip to content

Commit

Permalink
Merge pull request #352 from JoanneHing/user-guide
Browse files Browse the repository at this point in the history
Update user guide
  • Loading branch information
JoanneHing authored Nov 11, 2024
2 parents cc85ce5 + e4758a5 commit d292119
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ Exceptionally long names will be cut off on the display, but you can read the st
detail command.
</div>

<div style="page-break-after: always;"></div>
### Deleting a student : `delete`

Removes a student from the tuition center management system.
Expand Down Expand Up @@ -380,8 +379,6 @@ 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 @@ -428,8 +425,6 @@ 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 @@ -456,8 +451,6 @@ 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 Expand Up @@ -494,8 +487,6 @@ After finding, you can use `list` command to return to the full list of students

</div>

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

### Sorting students : `sort`

Sort the list of students based on a specified field.
Expand Down Expand Up @@ -532,8 +523,6 @@ group 2 students will be sorted.

</div>

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

### Filtering students : `filter`

Shows a list of students filtered by year group or subject.
Expand Down Expand Up @@ -564,8 +553,6 @@ will be displayed.
Filtering by year group followed by `tracksubject` allows you to see what subjects are taken by the students in the current year group.
</div>

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

## Subject Management
### Adding subject(s) to a student : `addsubject`

Expand Down Expand Up @@ -593,8 +580,6 @@ Examples:

![Addsubject Success Message](images/addsubject.png)

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

### Tracking student count for each subject : `tracksubject`

Displays a window that shows how many students are taking each of all the subjects.
Expand All @@ -618,8 +603,6 @@ Please ensure to close the tracker to view the most current information.

![TrackSubject Success Message](images/tracksubject.png)

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

## Utility Features
### Clearing all entries : `clear`

Expand Down Expand Up @@ -650,8 +633,6 @@ Format: `exit`

---

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

# Data Management in AcademyAssist

Welcome to the Data Management section of AcademyAssist! Here, we'll explain how your important information
Expand Down Expand Up @@ -704,8 +685,6 @@ If you ever have questions about your data, just ask - we're always happy to hel


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

# FAQ
This section provides answers to frequently asked questions about AcademyAssist. If you have any other questions or
encounter issues while using the application, please feel free to reach out to us via our email (academyassist@gmail.com).
Expand Down Expand Up @@ -744,8 +723,6 @@ main window for a cleaner user interface. To view more detailed information abou
command followed by the student's ID. This will provide you with all the additional details you need.<br><br>

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

# Upcoming Features
As part of our ongoing efforts to enhance the functionality of the student management system, we are excited to
introduce the following features aimed at providing greater flexibility in subject management:
Expand All @@ -770,8 +747,6 @@ users to manage student interactions effectively<br><br>
These planned features are designed to improve the administrative capabilities of our student management system, allowing for more efficient subject management. We welcome your feedback and suggestions as we work towards implementing these enhancements!

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

# Glossary
1. **Command**: An instruction given by a user to a computer program.
2. **Command Line Interface (CLI)**: A text-based interface for interacting with a program.
Expand Down

0 comments on commit d292119

Please sign in to comment.