Skip to content

Commit a86aae5

Browse files
committed
Improve UG
1 parent 9b21916 commit a86aae5

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/UserGuide.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pageNav: 3
1212

1313

1414

15-
TAPro is your go-to **Contact Book application**, created with love for **Computer Science Teaching Assistants (TAs)** like you. _We get it_ — juggling your students and keeping track of attendance can be a handful. That’s why TAPro is
15+
TAPro is your go-to **Contact Management application**, created with love for **Computer Science Teaching Assistants (TAs)** like you. _We get it_ — juggling your students and keeping track of attendance can be a handful. That’s why TAPro is
1616
here to make your life easier. With features designed precisely for you, it's all about simplifying those
1717
time-consuming tasks, letting you focus on what you do best: teaching and inspiring your students. Welcome to a
1818
smoother, more personalized way of managing your TA duties!
@@ -33,27 +33,28 @@ If you can type fast, TAPro can get your contact management and attendance takin
3333
Welcome to the cozy corner of the TAPro User Guide! 🌟 Whether you're embarking on your very first day as a TA or
3434
you're practically a wizard with student info, we've put together this guide to make sure you get the most out of TAPro.
3535

36-
🚀 **Ready to Roll?** Skip over to **[Quick Start](#quick-start)** for the no-fuss, easy-peasy steps to download TAPro and get ready for
37-
action.
3836

3937
**New around here?** No worries, we've got you. Start with these sections to become a TAPro buddy in no time:
40-
4138
- [Navigating the GUI](#navigating-the-gui): Familiarize yourself with the command box and those handy contact cards.
4239
- [Features](#features): Dive into the exciting world of features we've brewed up just for you.
4340

44-
**Already a TAPro champ?** Let's add some spice to your TA skills:
41+
42+
**Ready to Roll?** Skip over to **[Quick Start](#quick-start)** for the no-fuss, easy-peasy steps to download TAPro and get ready for
43+
action.
44+
45+
🚀 **Already a TAPro champ?** Let's add some spice to your TA skills:
4546

4647
- **[Set Course](#name-rename-cs-course-setcrs)**: Tailor TAPro to your current course with `setcrs`.
4748
- **[Add Student](#adding-a-student-addstu)**: Got a new face in class? Quickly add their details with `addstu`.
4849
- **[Mark](#marking-a-student-s-attendance-for-a-given-week-by-their-nusnet-mark)**: Keep track of weekly attendance with `mark`.
4950
- **[Unmark](#unmarking-a-student-s-attendance-for-a-given-week-by-their-nusnet-unmark)**: Oops, made a mistake? `unmark` reverses that mark.
5051
- **[List](#listing-all-students-list)**: Bring up a complete list of your students with `list`.
5152
- **[Edit](#editing-a-student-edit)**: Update details as they evolve with `edit`.
52-
- **[Find](#locating-students-by-name-find)**: Looking for someone? find helps you search by keyword.
53+
- **[Find](#locating-students-by-name-find)**: Looking for someone? `find` helps you search by keyword.
5354
- **[Delete Student](#deleting-a-student-delstu)**: Time to say goodbye? Remove a student from your list with `delstu`.
5455
- **[Clear](#clearing-all-entries-clear)**: Need to wipe the slate clean? `clear` does just that.
5556

56-
**Need a quick TAPro refresher?** Our Command Summary is like the TAPro bible—short, sweet, and to the point.
57+
**Need a quick TAPro refresher?** Our [Command Summary](#command-summary) is like the TAPro bible—short, sweet, and to the point.
5758

5859
Stumbled upon a hurdle or just curious? Swing by our **[FAQ](#faq)** where we tackle all your burning questions and offer
5960
nuggets of wisdom for a smooth TAPro journey.
@@ -63,7 +64,7 @@ nuggets of wisdom for a smooth TAPro journey.
6364

6465
This segment aims to make your TAPro experience as smooth as silk. With these notions and terms at your fingertips, you're well on your way to becoming a TAPro power user!
6566

66-
Diving into TAPro, you'll encounter some handy notations and terms. We've decoded them here to make your journey smoother and more enjoyable:
67+
Diving into TAPro, you'll encounter some handy notations and terms. We've decoded them here to make your journey smoother and more enjoyable.
6768

6869
### Symbols
6970

@@ -219,7 +220,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap
219220

220221
* `addstu nn/E0952224 n/John Doe p/98765432 e/johnd@example.com m/Computer Science` : Adds a student named `John Doe` to the contact book.
221222

222-
* `delstu nn/NUSNET` : Deletes the student with the specified `NUSNET` from the contact book.
223+
* `delstu nn/E0952224` : Deletes the student with NUSNet ID E0952224 from the contact book (assuming they were already in the contact book).
223224

224225
* `clear` : Deletes all students, and their contact and attendance information.
225226

@@ -602,7 +603,7 @@ Both `KEYWORD` and `[MORE_KEYWORDS]…​` accept alphanumeric and special symbo
602603

603604
{{ newPage }}
604605

605-
### <i class="fa-solid fa-square-check"></i> Marking a student's attendance for a given week by their NUSNet: `mark`
606+
### <i class="fa-solid fa-square-check"></i> Marking a student's attendance for a given week by their NUSNet ID: `mark`
606607

607608
Marks a student's attendance for a particular week.
608609

@@ -617,7 +618,7 @@ Marks a student's attendance for a particular week.
617618

618619
{{ newPage }}
619620

620-
### <i class="fa-solid fa-square-xmark"></i> Unmarking a student's attendance for a given week by their NUSNet: `unmark`
621+
### <i class="fa-solid fa-square-xmark"></i> Unmarking a student's attendance for a given week by their NUSNet ID: `unmark`
621622

622623
Unmarks a student's attendance for a particular week.
623624

0 commit comments

Comments
 (0)