Merge pull request nus-cs2103-AY2021S1#71 from Criss-Wang/master

Update team Github Page and README.md

README.md

@@ -1,14 +1,13 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2021S1-CS2103-W14-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-4/tp/actions)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
+* This is **software engineering project done by Team W14-4 from CS2103**.<br>
+  The project aims to:
+  * help medical supply managers keep track of medical products and storage
+  * allow fast typists to reap the benefit of swift user interaction with CLI and GUI
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
   * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
   * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+* It is named `CLI-nic` because it emphasizes on user interaction via CLI and serves to smoothen the clinical product's supply flow.
+* For the detailed documentation of this project, see the **[Product Website](https://ay2021s1-cs2103-w14-4.github.io/tp/)**.

docs/AboutUs.md

@@ -5,7 +5,7 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `[email protected]`
 
 ## Project team
 
@@ -59,7 +59,9 @@ checking on LoC contributions and milestones management
 [[github](http://github.com/Criss-Wang)]
 [[portfolio](team/wangZhenlin.md)]
 
-* Role: Contact/info manager; Tech Helper; In charge of 'Delete' command
-* Responsibilities:  In charge of communication issues (Setup channel/deal with emergency situation), 
-talk with every member before meeting about their progress and promptly update any lag of progress/course 
-info to the team. Try to help team members resolve small technical difficulties.
+* Role: Communication/progress manager; Tech Helper; 
+* Responsibilities: 
+    * In charge of `Delete` command.
+    * In charge of team communication (Setup channel/meeting schedule/deal with emergency situation).
+    * Track and manage team progression.
+    * Help team members with technical difficulties and catch up to the team's progress.

docs/UserGuide.md

@@ -4,7 +4,9 @@ title: User Guide
 Team: W14-4
 ---
 
-AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+CLI-nic is **an application to help medical supply managers keep track of medical products and storage.** It is optimized
+for these managers to **update product supply conditions and access critical product information quickly** via fast typing
+and efficient Graphical User Interface interaction.
 
 * Table of Contents
 {:toc}
@@ -123,19 +125,21 @@ Examples:
 * `find alex david` returns `Alex Yeoh`, `David Li`<br>
   ![result for 'find alex david'](images/findAlexDavidResult.png)
 
-### Deleting a person : `delete`
+### Removing a purchase order/store/product/supplier : `delete` [Coming soon]
 
-Deletes the specified person from the address book.
+Remove entries that are not needed anymore.
 
-Format: `delete INDEX`
+**Format**: `delete [LIST_TYPE] INDEX`
 
-* Deletes the person at the specified `INDEX`.
-* The index refers to the index number shown in the displayed person list.
-* The index **must be a positive integer** 1, 2, 3, …​
+* Deletes from the purchase order list by default at `INDEX`
+* The `LIST_TYPE` specified should be one of these values: **order/store/product/supplier**
+* The `INDEX` **must be a positive integer**, not exceeding the total number of items
 
-Examples:
-* `list` followed by `delete 2` deletes the 2nd person in the address book.
-* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
+
+**Examples**
+
+* `delete 1`: Removes the 1st order from the list of orders as no `LIST_TYPE` is specified.
+* `delete store 12`: Removes 12th store from the list of stores.
 
 ### Clearing all entries : `clear`
 

docs/_config.yml

@@ -1,4 +1,4 @@
-title: "AB-3"
+title: "CLI-nic"
 theme: minima
 
 header_pages:
@@ -8,7 +8,7 @@ header_pages:
 
 markdown: kramdown
 
-repository: "se-edu/addressbook-level3"
+repository: "AY2021S1-CS2103-W14-4/tp"
 github_icon: "images/github-icon.png"
 
 plugins:

docs/index.md

@@ -1,17 +1,19 @@
 ---
 layout: page
-title: AddressBook Level-3
+title: CLI-nic
 ---
 
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
+[![CI Status](https://github.com/Y2021S1-CS2103-W14-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-4/tp/actions)
+[![codecov](https://codecov.io/gh/Y2021S1-CS2103-W14-4/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103-W14-4/tp)
 
 ![Ui](images/Ui.png)
 
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+CLI-nic is **an application to help medical supply managers keep track of medical products and storage.** It is optimized
+for these managers to **update product supply conditions and access critical product information quickly** via fast typing
+and efficient Graphical User Interface interaction.
 
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+* If you are interested in using CLI-nic, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+* If you are interested about developing CLI-nic, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
 
 
 **Acknowledgements**

docs/team/wangZhenlin.md

@@ -1,5 +1,51 @@
-### Member description
+---
+layout: page
+title: Wang Zhenlin's Project Portfolio Page
+---
+
+## Project: CLI-nic
+
+CLI-nic is **an application to help medical supply managers keep track of medical products and storage.** It is optimized
+for these managers to **update product supply conditions and access critical product information quickly** via fast typing
+and efficient Graphical User Interface interaction.
+It is written in Java, and has about __ kLoC.
+
+Given below are my contributions to the project.
+
+* **Code contributed**: [RepoSense link]()
+
+* **New feature**: Added the ability to delete a supplier/supply/store/order.
+  * What it does:
+  * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+  * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
+  * Credits: {mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}
+
+* **Project management**:
+  * Managed releases `v1.3` - `v1.5rc` (_ releases) on GitHub
+
+* **Enhancements to existing features**:
+  * Updated the GUI (Pull requests [\#33](), [\#34]())
+  * Wrote additional tests for existing features to increase coverage from __% to __% (Pull requests [\#36](), [\#38]())
+
+* **Documentation**:
+  * Site-wide setting:
+    * Updated _config.yml.
+  * Index page:
+    * Modified content to fit CLI-nic project description, added relevant links.
+  * README:
+    * Modified content to fit CLI-nic project description.
+  * User Guide:
+    * Added documentation for the `delete` feature.
+  * Developer Guide:
+    * Added implementation details of the `delete` feature.
+
+* **Community**:
+  * PRs reviewed (with non-trivial review comments): nil
+  * Contributed to forum discussions (examples: nil)
+  * Reported bugs and suggestions for other teams in the class (examples: nil)
+  * Some parts of the history feature I added was adopted by several other class mates (nil)
+
+* **Tools**:
+  * nil
 
-This is a description about myself.
 
-Some more descriptions