From e445b199671446762cdb99e0b15897584de9f8db Mon Sep 17 00:00:00 2001 From: Jweng88 <108978684+Jweng88@users.noreply.github.com> Date: Wed, 1 Nov 2023 21:26:58 +0800 Subject: [PATCH 1/8] Update ug for list-t --- docs/UserGuide.md | 46 ++++++++++++++++++------- docs/images/listTutor.png | Bin 23821 -> 351719 bytes docs/images/listTutorCommandSyntax.png | Bin 0 -> 759 bytes 3 files changed, 33 insertions(+), 13 deletions(-) create mode 100644 docs/images/listTutorCommandSyntax.png diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0ba6f247224..7fc427f8fbd 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -305,28 +305,48 @@ You can also refer to [input information](#input-examples) for details about val #### Listing all tutors: `list-t` -Displays a list of all tutors in the address book in a table format. +Displays a list of all tutors in TutorConnect. + +##### :star: First time users +{:.no_toc} + +**Scenario** + +Imagine that you have found the details of the tutor John Doe and want to go back to view the list of tutors.\ +As a tuition centre coordinator, you want to view the list of tutors after filtering the list of tutors. + +Let's use the list tutor command to view the most updated list of tutors! + +**Follow these steps:** + +1. Type in `find-t John` and press enter to find any tutors with the name John. +2. Let's say you have successfully found one tutor named John Doe. +3. Type in `list-t` and press enter to go back to view the full updated list of tutors. + +**What you can expect to see** + +Great job! You have found the full updated list of tutors. ![list tutor](images/listTutor.png) -**Format**: `list-t` +##### :star::star::star: Experienced users +{:.no_toc} -**Example**: -* `list-t` +**Command format** -**Expected Output**: -* `Listed all tutors` +![list tutor command](images/listTutorCommandSyntax.png) -
OYfn)=z?Zb3nTjEc&;`}aG{P^Nu#kmejJ$76&*d(1Y+e}{MxA}Pkpx0%^fTBMTA
zNSsJ*XlyWB4Fyhi_w@8MXuF+acXGJlA0;vqLf%k(GB_7={|5bylGI;BF3r*rufP7=
z$p`Lq_}@B4Mn-EJ_V165GD? FwGNTm@~
zv2|$q(2+z^;X|1YmG)CE)o>Z0?-C+?3O~x6zk`|6%Mc}S>n>pNq8L>`6(CJ!q}X6z
z$jxH?=VpiJ=JMh0MaphW1s#~Ut%pJSNf-n=TMo~Y`$d=>ll1WlMoZO
zQ)@a2ZQ^fkt`caD`7D6s5_Fttimh~hKWf2=yOCNqVC8E*BZm*B3bG_kmCRG@@xha?
z@xj|O_}y(9_aDqq`43{tSm^YsN@f-4RWgV+PY)3nj3R-xplua#VItPJo<~e*E!H69)~Rf
zX6R8TO*Lf^!;_Bt!mH+IPD(TC?_Uc<>9L?KL^6u+!5cYQ*U&6}(?YUi>EiYmRSV62
z^@6}blZg+thQ5Avnrx2PuXa5;K86;o0IsUU7u)D
Sh=~8C1U^2X&ruXxUgAT
zPoI&mBMc}LmKBinJb>0KB^65U4Yk6Q=KT9$SvE40N0HuY4`sCT4`J$m?T)8R;-=wj
zoq}#iMQQK#h{Oo2By3Sj^Yn33>!I{rKysXh$hPtVCQDvIS9;vpqACdV+f%NJkLZH$
zrf%RXpi()eIilx$SzgJx&8dueLj$FV8PLs)CCI3;?`r^uLBSM1Z%Q2u2?4PAuXe
zkB6!Qs3pK{uo(bvug?JNw$tWK(ceLte$PG1uxvfR$0Y{ib%945TU|Hn6A$v*$oJ
zn*Mm(=x~=$*M!TcZXB#0uql0K%y0L!`gC+21ZpPe+2pO`yO4Eu=uUx6&k}W;^IE$0
zd|0^56SB9Uv!Kca(9tTIOZR`?42mQp4!%rhWE?xGQ|Ks_n#9k4`gu)4!If&joDZ3{
zL4}%Le=C-8w;itXfh9ez=HQe9H(0iLTIZFW7eNDsM4Kw;vDry#b%*3hF8G;*1dx-x
zTggq@akf~0Kdt9ky_MxmmE
zqSaatpnX=%+5}vS$h)g`nxKha&(cE|U9%=xR}F4