Add adoc header tags (#263)

gb3h · gb3h · web-flow · commit 67f7f74e47d1 · 2020-04-13T23:00:06.000+08:00
* Edit

* PR+

* Edit PPP for stephen

* Edit PPP for stephen

Co-authored-by: gb3h &lt;gabriel_yfy@hotmail.com&gt;
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -24,7 +24,7 @@ Refer to the guide <<SettingUp#, here>>.
 == Design
 
 [[Design-Architecture]]
-=== Architecture
+=== Architecture [Wong Chi Shan]
 
 .Architecture Diagram
 image::developer-guide/common/ArchitectureDiagram.png[]
@@ -69,7 +69,7 @@ image::developer-guide/common/ArchitectureSequenceDiagram.png[]
 The sections below give more details of each component.
 
 [[Design-Main]]
-=== Main Component
+=== Main Component [Aloysius Chan]
 .Structure of the Main Component
 image::developer-guide/common/MainClassDiagram.png[]
 
@@ -82,7 +82,7 @@ When the app starts up, `Main#main` is called. This sets the `Preloader` of the
 During the GUI start up process, the `SplashScreen` will first load on a `Thread`. In the meantime, `MainApp#init` will run. Once `MainApp#init` completes, and just as `MainApp#start` is about to run, `MainApp` will send a `Preloader.StateChangeNotification` to `SplashScreen` to close its window. After that, `UiManager#start` is called, which creates the view for the main application.
 
 [[Design-Ui]]
-=== UI Component
+=== UI Component [Aloysius Chan]
 
 .Structure of the UI Component
 image::developer-guide/common/UiClassDiagram.png[]
@@ -98,7 +98,7 @@ The `UI` component executes user commands using the `Logic` component.
 For more information about each component, check out the 'Implementation' section.
 
 [[Design-Logic]]
-=== Logic Component
+=== Logic Component [Aloysius Chan]
 
 [[fig-LogicClassDiagram]]
 .Structure of the Logic Component
@@ -126,7 +126,7 @@ NOTE: The lifeline for `ExerciseCommandParser` and `DeleteCommandParser` should
 For more information about each component, check out the 'Implementation' section.
 
 [[Design-Model]]
-=== Model Component
+=== Model Component [Aloysius Chan]
 
 .Structure of the Model Component
 image::developer-guide/common/ModelClassDiagram.png[]
@@ -148,7 +148,7 @@ The `Model`:
 For more information about each component, check out the 'Implementation' section.
 
 [[Design-Storage]]
-=== Storage Component
+=== Storage Component [Aloysius Chan]
 
 .Structure of the Storage Component
 image::developer-guide/common/StorageClassDiagram.png[]
@@ -176,7 +176,7 @@ This section describes some noteworthy details on how each features are implemen
 
 // tag::session[]
 
-=== Session (Home)
+=== Session (Home) [Gabriel Yeo]
 ==== Implementation
 The Session feature resides on the Home page and is comprised of `Start`, `Stop`, `Done`, and `Skip` commands.
 `OngoingWorkout`, `OngoingSession`, `OngoingSet`, and `OngoingSetList` are models that are vital components of the feature.
@@ -274,9 +274,7 @@ workout session, where all remaining sets are marked as incomplete.
 // end::session[]
 
 // tag::exercise[]
-=== Exercise
-Aloysius Chan
-
+=== Exercise [Aloysius Chan]
 ==== Overview
 The Exercise feature forms the basic building block for the application. It allows users to CRUD exercises, which will then be used for the creation of workouts. The command is prefixed by the keyword `exercise`. Available commands are `create`, `edit`, `list`, `delete` and many more.
 
@@ -368,7 +366,7 @@ However, for exercises, we noted that users tend to reuse the same exercise thro
 // end::exercise[]
 
 // tag::workout[]
-=== Workout
+=== Workout [Wong Chi Shan]
 ==== Overview
 The workout feature in ZeroToOne allows users to manage their workouts! Users will be able to create a workout, add exercises to it, as well as edit the workout and its exercises, and more.
 
@@ -467,8 +465,8 @@ other than the context that they are referenced in. In addition, this would make
 // end::workout[]
 
 // tag::schedule[]
-=== Schedule
-Guofeng Tang
+=== Schedule [Tang Guofeng]
+
 
 ==== Overview
 The schedule feature in ZeroToOne allows users to plan their workouts! Users will be able to create a schedule on a specific date and time in the future, edit the date and time, as well as delete the schedule.
@@ -576,7 +574,7 @@ On the other hand, implementing option 2 makes it easier to handle these problem
 
 
 // tag::log[]
-=== Log Statistics
+=== Log Statistics [Liow Jiachen]
 The log statistics feature in ZeroToOne allows users to view their completed workouts visually with meaningful aggregated information so they can see how much progress made.
 
 ==== Overview
@@ -721,7 +719,7 @@ Refer to the guide <<DevOps#, here>>.
 Manage workouts faster than a typical mouse/GUI-driven app
 
 [appendix]
-== User Stories
+== User Stories [Wong Chi Shan]
 
 Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*`
 
@@ -762,7 +760,7 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 |=======================================================================
 
 [appendix]
-== Use Cases
+== Use Cases [Wong Chi Shan]
 
 (For all use cases below, the *System* is the `ZeroToOne` and the *Actor* is the `user`, unless specified otherwise)
 
@@ -876,7 +874,7 @@ A set of exercises to be done together, in a certain order and time frame.
 
 //tag::gb3h[]
 [appendix]
-== Instructions for Manual Testing
+== Instructions for Manual Testing [Gabriel Yeo]
 
 Given below are instructions to test the app manually.
 
@@ -925,8 +923,7 @@ These instructions only provide a starting point for testers to work on; testers
 
 //tag::session[]
 [appendix]
-== Effort
-Gabriel Yeo
+== Effort [ZeroToOne Team]
 
 
 [width="59%",cols="22%,<23%,<25%,options="header",]
@@ -960,7 +957,6 @@ Furthermore, on top of the ~16k LoC added to the project, the ZeroToOne team has
 The largest challenge we faced as a team was communication.
 Being fast-moving and driven individuals, taking the initiative sometimes meant being able to make decisions for the team as an individual. This meant that it was vital that we were on the same page with our goals and expectations from the project.
 Thus, we took more time than usual at the beginning of the project to plan our road-map moving forward, delegating work and defining our expectations clearly.
-This meant we were later to start coding and making PRs than other teams (as seen on reposense), which we felt was a more-than-fair trade-off for our team dynamic.
 
 We hope you have enjoyed this journey and learnt as much as we have!
 - The ZeroToOne Team
diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -74,8 +74,7 @@ image::user-guide/UgMainPage.png[]
 At this stage, you should have successfully started ZeroToOne and will be able see the main page as described in Figure 1. If the application did not start, please refer to <<Troubleshooting>> for more information to resolve the issue. Otherwise, the next step is to begin your ZeroToOne journey, by customising your favourite workout programmes!
 
 // tag::ui[]
-== User Interface Basics
-Chi Shan
+== User Interface Basics [Wong Chi Shan]
 
 Before we delve into the commands that you can use, let us first explain the components of the User Interface, and how we can navigate through them.
 
@@ -99,7 +98,7 @@ You type all of your commands in here. To execute the command, simply press the
 
 At this point, you should have sufficient knowledge to start using ZeroToOne. In this section, we will describe in-depth the features that ZeroToOne has, and how you can interact with them.
 
-=== Overview
+=== Overview [Wong Chi Shan]
 For ZeroToOne commands, every user-fillable parameter is identified by a flag prefix. This allows ZeroToOne to accept parameters in any order. However, to correctly parse your command, we have reserved these flags as special symbols that are to be used only by the program. Please avoid using them in your commands. The reserved flags are listed as follows:
 
 * `e/` - exercise name
@@ -114,9 +113,7 @@ For ZeroToOne commands, every user-fillable parameter is identified by a flag pr
 * `et/` - end datetime
 
 // tag::about[]
-=== Viewing App Information
-Chi Shan
-
+=== Viewing App Information [Wong Chi Shan]
 Can’t remember the commands off the top of your head? Fret not. ZeroToOne provides you with a convenient way to view a list of all available commands that you can try. Simply enter the following command into the command box:
 
 ```
@@ -129,7 +126,7 @@ The app view will switch tabs to show the About tab.
 
 // end::about[]
 
-=== Closing ZeroToOne
+=== Closing ZeroToOne [Wong Chi Shan]
 After you have finished using the application, you can exit the application by simply entering the following command into the command box:
 
 ```
@@ -144,8 +141,7 @@ Thank you for using ZeroToOne! Your data has been saved successfully. Hope to se
 
 //tag::session[]
 
-=== Starting A Workout Session
-Gabriel Yeo
+=== Starting A Workout Session [Gabriel Yeo]
 
 Are you ready to start working out now? To begin a new workout session, simply enter the following command into the command box:
 
@@ -169,7 +165,7 @@ NOTE:
 * WORKOUT_ID cannot be null and should be a value of a workout from the workout tab.
 ```
 
-=== Completing a Set
+=== Completing a Set [Gabriel Yeo]
 Completed your exercise set? To mark the current exercise set as complete and move on to the next set, simply enter this command into the command box:
 
 ```
@@ -186,7 +182,7 @@ After however many seconds you wish to rest, you may continue on to your next se
 
 If you were already on your last set, ZeroToOne will automatically stop the workout session after this command is executed and save your session to the `Log`.
 
-=== Skipping An Exercise Set
+=== Skipping An Exercise Set [Gabriel Yeo]
 Unable to complete your current exercise set? No worries, it happens to the best of us. To skip the current exercise set, simply enter this command into the command box:
 
 ```
@@ -200,7 +196,7 @@ The background color of the completed set will turn red, indicating that the set
 
 This action is otherwise identical to the `done` command.
 
-=== Stopping A Workout Session
+=== Stopping A Workout Session [Gabriel Yeo]
 Need to stop the workout session prematurely? Simply enter this command into the command box:
 
 ```
@@ -217,9 +213,7 @@ Stopped workout session: Push Day at 13 Apr 2020, 3:36:17 PM
 //end::session[]
 
 // tag::exercise[]
-=== Managing Your Exercises
-Aloysius Chan
-
+=== Managing Your Exercises [Aloysius Chan]
 The commands in this section allows you to manage your customised exercises in ZeroToOne. These exercises will eventually be the building blocks of a workout.
 
 ==== Creating a new exercise
@@ -400,8 +394,7 @@ Deleted Exercise: Deadlift
 // end::exercise[]
 
 // tag::workout[]
-=== Managing Your Workouts
-Chi Shan
+=== Managing Your Workouts [Wong Chi Shan]
 
 After creating and modifying your exercises however you desire, it’s time to use those exercises to create workouts! In this section, we will walk you through how to manage all your workouts.
 
@@ -626,8 +619,7 @@ Successfully imported /data/myFriendsWorkout.txt as a new workout: My Friend's W
 // end::workout[]
 
 // tag::schedule[]
-=== Managing Your Scheduled Sessions
-Guofeng Tang
+=== Managing Your Scheduled Sessions [Tang Guofeng]
 
 You are now an expert in managing your workouts, and can start a workout any time! However, wouldn’t you like to have the ability to schedule your workout sessions? In this section, we will guide you to learn how ZeroToOne can help you in this aspect!
 
@@ -653,7 +645,7 @@ NOTE:
 * <datetime> must not be outdated and follow the format {yyyy}-{mm}-{dd} {HH:mm}
 ```
 
-==== Listing all scheduled sessions
+==== Listing all scheduled sessions [Tang Guofeng]
 
 To view all of your schedule sessions, type the following command:
 
@@ -743,7 +735,7 @@ NOTE:
 // end::schedule[]
 
 // tag::log[]
-=== Managing Your Session Logs
+=== Managing Your Session Logs [Liow Jiachen]
 Well done, you have successfully gone through the whole process of setting up your workouts, scheduling them and even logging the workout. In addition to all these cool features, ZeroToOne also allows you to manage your workout log history and even provides you with meaningful statistics to help you track your current progress to help you hit all those fitness goals.
 
 ==== Viewing your logs
@@ -947,7 +939,7 @@ A single type of exercise, for example push ups or crunches.
 
 *Gradle*
 
-A build automation tool...
+A build automation tool.
 
 *GUI*
 
@@ -960,7 +952,7 @@ A specific instantiation of an object.
 
 *Java*
 
-A programming language...
+A programming language.
 
 *Mainstream OS*
 
@@ -983,4 +975,5 @@ An exercise set that consists of the number of repetitions and its weight.
 A list of exercises to be done together, in a certain order.
 
 *Log*
+
 A workout that has been completed and stored away safely.
diff --git a/docs/team/Guofeng-Tang.adoc b/docs/team/Guofeng-Tang.adoc
@@ -5,9 +5,6 @@
 
 == PROJECT: ZeroToOne
 
-.Screenshot
-image::user-guide/UgScheduleSession.png[]
-
 == Overview
 
 ZeroToOne is a desktop application that serves as an all-in-one exercise tracker and personal aide. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 26 kLoC.
@@ -18,7 +15,7 @@ ZeroToOne is a desktop application that serves as an all-in-one exercise tracker
 
 ** What it does: allows the user to schedule workout sessions.
 
-** Justification: this feature is essential to the product as it enbale user to make plans of their workout sessions, stick to the plans and finally achieve a life transformation.
+** Justification: this feature is essential to the product as it enable user to make plans of their workout sessions, stick to the plans and finally achieve a life transformation.
 
 ** Highlights: this feature affects efficiency and responsiveness if not implemented correctly. It required careful consideration and analysis of design alternatives. The implementation itself was challenging because it required implementation of a fairly complex model as well as its storage.
 
diff --git a/docs/team/alloystory.adoc b/docs/team/alloystory.adoc
@@ -5,8 +5,6 @@
 
 == PROJECT: ZeroToOne
 
-.Screenshot
-image::user-guide/UgExerciseList.png[]
 
 == Overview
 
diff --git a/docs/team/chishanw.adoc b/docs/team/chishanw.adoc
@@ -5,8 +5,6 @@
 
 == PROJECT: ZeroToOne
 
-.Screenshot
-image::user-guide/UgWorkoutList.png[]
 
 == Overview
 
diff --git a/docs/team/gb3h.adoc b/docs/team/gb3h.adoc
@@ -29,20 +29,23 @@ Major design consideration was required to ensure that the timer was not computa
 
 ** *Overview*: https://nus-cs2103-ay1920s2.github.io/tp-dashboard/#search=gb3h&sort=groupTitle&sortWithin=title&since=2020-02-14&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false[Reposense]
 
-** *Functional Code*:
+|===
+|*Feature* |*Component* |*Functional Code* |*Test Code*
+
+.5+|Session feature |Commands (Start, Stop, Skip, Done) |https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master/src/main/java/seedu/zerotoone/logic/commands[github folder] |https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/logic/commands[github folder]
+
+|Parsers |https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master/src/main/java/seedu/zerotoone/logic/parser/session[github folder] |https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/logic/parser/session[github folder]
+
+|Models (Ongoing- prefixed) |https://github.com/gb3h/main/tree/master/src/main/java/seedu/zerotoone/model/session[github folder] |https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/model/session[github folder]
 
-1. https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master/src/main/java/seedu/zerotoone/logic/commands[github folder] <- Commands (Start, Stop, Skip, Done)
-2. https://github.com/AY1920S2-CS2103T-W16-2/main/tree/master/src/main/java/seedu/zerotoone/logic/parser/session[github folder] <- Parsers
-3. https://github.com/gb3h/main/tree/master/src/main/java/seedu/zerotoone/model/session[github folder] <- Models (All the Ongoing- models and worked in collaboration with @Jiachen247 for some Completed- models)
-4. https://github.com/gb3h/main/tree/master/src/main/java/seedu/zerotoone/ui/views/home[github folder] <- UI work
-5. https://github.com/gb3h/main/tree/master/src/main/resources/view/home[github folder] <- FXML
-6. https://github.com/AY1920S2-CS2103T-W16-2/main/blob/master/src/main/java/seedu/zerotoone/model/ModelManager.java[github file] <- Timer functionality (and major session-related functions)
+|Ui |https://github.com/gb3h/main/tree/master/src/main/java/seedu/zerotoone/ui/views/home[github folder] | NA
 
-** *Tests*:
+|FXML |https://github.com/gb3h/main/tree/master/src/main/resources/view/home[github folder] |NA
+
+.1+|Timer feature |Found in ModelManager |https://github.com/AY1920S2-CS2103T-W16-2/main/blob/master/src/main/java/seedu/zerotoone/model/ModelManager.java[github file] | NA
+
+|===
 
-1. https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/logic/commands[github folder] <- Command Tests (Start, Stop, Skip, Done)
-2. https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/logic/parser/session[github folder] <- Parser Tests
-3. https://github.com/gb3h/main/tree/master/src/test/java/seedu/zerotoone/model/session[github folder] <- Model Tests
 
 ---
 
@@ -55,14 +58,14 @@ Major design consideration was required to ensure that the timer was not computa
 *** Edit GUI for overall cohesiveness (Pull requests https://github.com/AY1920S2-CS2103T-W16-2/main/pull/213[#213], https://github.com/AY1920S2-CS2103T-W16-2/main/pull/219[#219])
 *** Disabled non session related commands during a session for more predictable app behaviour (no editing of workouts during workout) (Pull requests https://github.com/AY1920S2-CS2103T-W16-2/main/pull/187[#187])
 ** Documentation:
-*** Add documentation coverage for the entire workout session feature including diagrams. https://github.com/AY1920S2-CS2103T-W16-2/main/pull/110[#14]
+*** Add documentation coverage for the entire workout session feature including diagrams. https://github.com/AY1920S2-CS2103T-W16-2/main/pull/110[#110]
 *** Edit Model Component diagram. https://github.com/AY1920S2-CS2103T-W16-2/main/pull/238[#238]
 *** Update all screenshots in user guide. https://github.com/AY1920S2-CS2103T-W16-2/main/pull/241[#241]
 *** Add DG Appendix F and G. https://github.com/AY1920S2-CS2103T-W16-2/main/pull/244[#244], https://github.com/AY1920S2-CS2103T-W16-2/main/pull/254[#254]
 ** Review Contributions:
 *** PRs reviewed (with non-trivial review comments):
 https://github.com/AY1920S2-CS2103T-W16-2/main/pull/66[#66], https://github.com/AY1920S2-CS2103T-W16-2/main/pull/114[#114]
-*** Total PRs reviewed: https://github.com/AY1920S2-CS2103T-W16-2/main/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Agb3h[15]
+*** Total PRs reviewed: https://github.com/AY1920S2-CS2103T-W16-2/main/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Agb3h[21+]
 ** Community:
 *** Reviewed other teams documentation: https://github.com/nus-cs2103-AY1920S2/addressbook-level3/pull/29[#29]
 
