Revamp overview section of UG #233

benclmnt · 2020-11-03T10:41:21Z

Should we also change the command summary to be like this

codecov · 2020-11-03T10:42:56Z

Codecov Report

Merging #233 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #233   +/-   ##
=========================================
  Coverage     65.09%   65.09%           
  Complexity      778      778           
=========================================
  Files           110      110           
  Lines          2739     2739           
  Branches        304      304           
=========================================
  Hits           1783     1783           
  Misses          847      847           
  Partials        109      109

Impacted Files	Coverage Δ	Complexity Δ
...ress/logic/commands/session/AddSessionCommand.java	`85.71% <ø> (ø)`	`8.00 <0.00> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e301173...8dbdf1e. Read the comment docs.

kelvinvin

A good rehaul of the how to use section to make the UG more friendly to the reader. Just a few minor suggestions!

kelvinvin · 2020-11-03T12:30:58Z

docs/UserGuide.md

@@ -23,7 +23,7 @@ If this is your first time, here are some quick tips to get started.

 1. Copy the file to the folder you want to use as the _home folder_ for your **FitEgo** program.

-1. Double-click the file to start the app. The GUI similar to the figure below should appear in a few seconds. Note how the app contains some sample data.<br>
+1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>


I think we should keep the word "figure" :) one of the reviewers picked on this previously (#209) which is why I added figure

oops, I might have messed up when resolving conflict. Thanks for spotting this out. Reverting..

kelvinvin · 2020-11-03T12:34:51Z

docs/UserGuide.md


-All [client-related commands](#32-client-related-keywords) use prefix `c`. 
+FitEgo lets you record crucial information that you want to keep track of using three types of items:


I'm not sure whether to call them items or entities, cos I think it might be a little weird to call clients items. Your call!

I'll go with entities then

kelvinvin · 2020-11-03T12:35:36Z

docs/UserGuide.md

+-----|-------| -------------------
+Client | c | Your client
+Session | s | Timeslot for a fitness session
+Schedule | sch | A schedule you made with your client


Schedule: A client's booking of a session

kelvinvin · 2020-11-03T12:36:59Z

docs/UserGuide.md

-#### Sessions
+Item | Prefix | What it represents
+-----|-------| -------------------
+Client | c | Your client


Client: A client that is either interested or has engaged your services

kelvinvin · 2020-11-03T12:37:59Z

docs/UserGuide.md


-Sessions are timeslots that are marked for a training session. It contains information about the gym, the session's main exercise type, start time and the duration of sessions.
+And here's what you can do:
+1. When you find a client that is interested in your fitness training services, add it to your list of clients with the: <br />


..add him to..

kelvinvin · 2020-11-03T12:48:48Z

docs/UserGuide.md

+
+Sessions represents a timeslot that is scheduled for a training session. It contains information about the gym, the session's main exercise type, start time and the duration of sessions.
+
+Each session can have more than 1 client, to model a trainer instructing a fitness class.


Perhaps rephrase the line "Each session can have more than 1 client" in case it implies container? "Each session can be attended by multiple clients"?

kelvinvin · 2020-11-03T12:50:05Z

docs/UserGuide.md


 Format: `sadd g/GYM_NAME ex/EXERCISE_TYPE at/START_TIME t/DURATION`

 Points to take note when adding a session to the Session List:
-* Start time should be of format "dd/MM/yyyy HHmm".
+* Start time should be of format "dd/MM/yyyy HHmm" (date/month/year Hour minutes).


day/month/year hour minutes in 24hr format

kelvinvin · 2020-11-03T12:52:36Z

docs/UserGuide.md

+<div markdown="block" class="alert alert-info"> 
+
+:information_source: **Info:**
+FitEgo doesn't allow user to create overlapping sessions. We consider two sessions as overlapping if another session starts before the current session ends.


Hmm I know you didn't change this one, but I'm thinking we can change it to "FitEgo will not allow you.." so its more reader-centric and avoids short form like "doesn't"

kelvinvin · 2020-11-03T12:54:35Z

docs/UserGuide.md

+
+:information_source: **Info:**
+FitEgo doesn't allow user to create overlapping sessions. We consider two sessions as overlapping if another session starts before the current session ends.
+This is to prevent accidental schedule overlaps at different gyms. 


I think we should avoid using the keyword "schedule" here too haha since there's no logical link to clients here. Perhaps "This is to prevent concurrent sessions at different gyms from being accidentally created"?

kelvinvin · 2020-11-03T13:03:06Z

docs/UserGuide.md


-There are 3 major entities in FitEgo (clients, sessions, and schedules), and 5 major verbs (add, edit, delete, view, list).
+Your clients' details, clients' progress, clients' payment status, and your own schedules are spread across 3 or 4 different applications. 


"Your records of your clients' details, training progress, payment status and your own timetable are spread across 3 or 4 different applications."

kelvinvin · 2020-11-03T13:06:53Z

Should we also change the command summary to be like this

I'm in favor of this change. Less space wasted by the Common Commands column

dhafinrazaq · 2020-11-03T13:11:42Z

docs/UserGuide.md

+
+Each session can have more than 1 client, to model a trainer instructing a fitness class.
+
+All of the session-related commands will interact with the Session List which is located at the [right of the UI](#2-ui-orientation). The figure below shows how it looks like.


based on another kelvin's comment, then this one might be "on the right"

dhafinrazaq · 2020-11-03T13:13:40Z

src/main/java/seedu/address/logic/commands/session/AddSessionCommand.java

@@ -31,7 +31,8 @@
            + PREFIX_DURATION + "120 ";

    public static final String MESSAGE_SUCCESS = "New Session added: %1$s";
-    public static final String MESSAGE_DUPLICATE_SESSION = "This Session already exists in FitEgo.";
+    public static final String MESSAGE_DUPLICATE_SESSION = "This Session overlaps with an existing Session in FitEgo.\n"
+            + "A Session is considered overlapping if another Session starts before the current session ends.";


should the second session start with capital s?

kelvinvin · 2020-11-03T15:23:04Z

docs/UserGuide.md


-Someone who is interested in your fitness training services
+A Client are someone who is interested in or has engaged with your fitness training services.


*"A client is"

kelvinvin · 2020-11-03T15:23:29Z

docs/UserGuide.md

+
+FitEgo will not allow you to create overlapping sessions. We consider two sessions as overlapping if another session starts before the current session ends.
+
+This helps to prevent you from accidentally agreeing to 2 sessions that overlaps with each other but are located on two different gyms. 


*"overlap with"
*"located in"

Sorry for checking the edits this late!

Revamp overview section of UG

337ec66

benclmnt requested a review from kelvinvin November 3, 2020 10:41

kelvinvin approved these changes Nov 3, 2020

View reviewed changes

dhafinrazaq reviewed Nov 3, 2020

View reviewed changes

benclmnt added 2 commits November 3, 2020 22:05

Fix based on peer reviews

bf22a17

Change command summary

a871641

benclmnt force-pushed the ug branch from 0f7a788 to a871641 Compare November 3, 2020 14:18

Merge branch 'master' into ug

8dbdf1e

benclmnt merged commit cde24c5 into master Nov 3, 2020

kelvinvin reviewed Nov 3, 2020

View reviewed changes

tanweijie123 deleted the ug branch November 8, 2020 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revamp overview section of UG #233

Revamp overview section of UG #233

benclmnt commented Nov 3, 2020 •

edited

codecov bot commented Nov 3, 2020 •

edited

kelvinvin left a comment

kelvinvin Nov 3, 2020

benclmnt Nov 3, 2020

kelvinvin Nov 3, 2020

benclmnt Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin commented Nov 3, 2020

dhafinrazaq Nov 3, 2020

dhafinrazaq Nov 3, 2020

benclmnt Nov 3, 2020

kelvinvin Nov 3, 2020

kelvinvin Nov 3, 2020 •

edited


		All [client-related commands](#32-client-related-keywords) use prefix `c`.
		FitEgo lets you record crucial information that you want to keep track of using three types of items:


		Sessions represents a timeslot that is scheduled for a training session. It contains information about the gym, the session's main exercise type, start time and the duration of sessions.

		Each session can have more than 1 client, to model a trainer instructing a fitness class.


		There are 3 major entities in FitEgo (clients, sessions, and schedules), and 5 major verbs (add, edit, delete, view, list).
		Your clients' details, clients' progress, clients' payment status, and your own schedules are spread across 3 or 4 different applications.


		Each session can have more than 1 client, to model a trainer instructing a fitness class.

		All of the session-related commands will interact with the Session List which is located at the [right of the UI](#2-ui-orientation). The figure below shows how it looks like.


		Someone who is interested in your fitness training services
		A Client are someone who is interested in or has engaged with your fitness training services.


		FitEgo will not allow you to create overlapping sessions. We consider two sessions as overlapping if another session starts before the current session ends.

		This helps to prevent you from accidentally agreeing to 2 sessions that overlaps with each other but are located on two different gyms.

Revamp overview section of UG #233

Revamp overview section of UG #233

Conversation

benclmnt commented Nov 3, 2020 • edited

codecov bot commented Nov 3, 2020 • edited

Codecov Report

kelvinvin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kelvinvin commented Nov 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kelvinvin Nov 3, 2020 • edited

Choose a reason for hiding this comment

benclmnt commented Nov 3, 2020 •

edited

codecov bot commented Nov 3, 2020 •

edited

kelvinvin Nov 3, 2020 •

edited