From 629a1889c58b1b1ea13b03141a638bc7abfd7f2e Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 09:33:03 +0800 Subject: [PATCH 1/8] Fix "not sure what command" box hyperlinks --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a636df432d6..26efa1276a5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -120,9 +120,9 @@ Some example commands you can try: **:bulb: Not sure what the commands above does?** -You can find all about the usable commands [here](#2-features),
-look at a summary of all the usable commands [here](#72-command-summary),
-OR return to the [Table of Contents](#table-of-contents) to find your desired command. +* Find all about the usable commands [here](#features) +* Look at a summary of all the usable commands [here](#command-summary) +* Return to the [Table of Contents](#toc-heading) to find your desired command From 7d4d8c5afdd315f394ae9a73a232367cfa663438 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 09:35:01 +0800 Subject: [PATCH 2/8] Fix grammar error --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 26efa1276a5..8405dd0868c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -118,7 +118,7 @@ Some example commands you can try:
-**:bulb: Not sure what the commands above does?** +**:bulb: Not sure what the commands above do?** * Find all about the usable commands [here](#features) * Look at a summary of all the usable commands [here](#command-summary) From 93e44b7fbaf69731f35fd8d9af84be72320bfb16 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:52:38 +0800 Subject: [PATCH 3/8] Update JAR file link --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8405dd0868c..5de7ef3208d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -70,7 +70,7 @@ An example is shown below. ### Installation -**Step 1.** Download the latest `tafinder.jar` from [here](). +**Step 1.** Download the latest `tafinder.jar` from [here](https://github.com/AY2324S1-CS2103T-W10-1/tp/releases/latest). **Step 2.** Copy the file to the folder you want to use as the _home folder_ for your TAfinder. From 0b67c64ebb05a6977dc504c6e9531aaeceda257a Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:56:13 +0800 Subject: [PATCH 4/8] Update README --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 97abd6c643e..28ae4ed9237 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,22 @@ TAfinder is a desktop app for NUS professors to find and track Teaching Assistan ![Ui](docs/images/Ui.png) ## Features -### Basic Applicant management -- Listing all applicants: list -- Hiding/unhiding an applicant from the list: hide/unhide -- Editing an applicant's information: edit -- Adding an applicant: add -- Viewing an applicant's details: view - -## Future updates -### Applicant evaluation & comparison -- Sorting applicants by grades: sort-gpa -- Comparing 2 applicants: compare -- Bookmarking/Unbookmarking an applicant: bookmark/unbookmark -- Adding comments for an applicant: add -### Data management and export -- Exporting applicants into a spreadsheet -- Attaching file to an applicant's profile + +- **Basic Applicant management** + - Listing all applicants: `list` + - Hiding/unhiding an applicant from the list: `hide`/`unhide`` + - Editing an applicant's information: `edit` + - Adding an applicant: `add` + - Viewing an applicant's details: `view` +- **Applicant evaluation & comparison** + - Sorting applicants by grades: `sort` + - Comparing 2 applicants: `compare` + - Bookmarking/Unbookmarking an applicant: `bookmark`/`unbookmark`` + - Adding comments for an applicant: `comment` +- **Data management and export** + - Import applicants from a spreadsheet: `import` + - Attaching file to an applicant's profile: `attach` ## Issues and Bugs + Spot a bug? Let us know by launching a Bug Report at the [Issues tab](https://github.com/AY2324S1-CS2103T-W10-1/tp/issues)! From 6d42dce50fe60c721d7a2f03452e5f7318500aef Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:56:20 +0800 Subject: [PATCH 5/8] Update badges in docs landing page --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index afb01e7cab1..9cc283f8b04 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,8 +3,8 @@ layout: default title: Home --- -[![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/AY2324S1-CS2103T-W10-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-W10-1/tp/actions) +[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp/graph/badge.svg?token=4DBT7T1IUV)](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp) ![Ui](images/Ui.png) From e14ac047860a70a03f073b174da93544854871c4 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:57:57 +0800 Subject: [PATCH 6/8] Improve landing page further --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9cc283f8b04..e345c3c4511 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,10 +8,10 @@ title: Home ![Ui](images/Ui.png) -**TAfinder 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). +**TAfinder is a desktop resource management application used by NUS SoC professors to choose TAs from a large pool of applicants.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface). -* 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 TAfinder, head over to the [**User Guide**](UserGuide.html). +* If you are interested about developing TAfinder, the [**Developer Guide**](DeveloperGuide.html) is a good place to start. **Acknowledgements** From ebcc101ffe46155c1a8ed04ce4ab8b6f265258b0 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:58:56 +0800 Subject: [PATCH 7/8] Fix inconsistencies in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 28ae4ed9237..0a95dd329be 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp/graph/badge.svg?token=4DBT7T1IUV)](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp) -This is a CS2103T project by [**AY2324S1-CS2103T-W010-1**](https://github.com/AY2324S1-CS2103T-W10-1/tp). It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/). +This is a CS2103T project by [AY2324S1-CS2103T-W10-1](https://github.com/AY2324S1-CS2103T-W10-1/tp). It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/). TAfinder is a desktop app for NUS professors to find and track Teaching Assistant (TA) information. It is optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you are an NUS professor that can type fast, and who is in need of an app to find and manage TA information, TAfinder is the app for you! @@ -12,14 +12,14 @@ TAfinder is a desktop app for NUS professors to find and track Teaching Assistan - **Basic Applicant management** - Listing all applicants: `list` - - Hiding/unhiding an applicant from the list: `hide`/`unhide`` + - Hiding/unhiding an applicant from the list: `hide`/`unhide` - Editing an applicant's information: `edit` - Adding an applicant: `add` - Viewing an applicant's details: `view` - **Applicant evaluation & comparison** - Sorting applicants by grades: `sort` - Comparing 2 applicants: `compare` - - Bookmarking/Unbookmarking an applicant: `bookmark`/`unbookmark`` + - Bookmarking/Unbookmarking an applicant: `bookmark`/`unbookmark` - Adding comments for an applicant: `comment` - **Data management and export** - Import applicants from a spreadsheet: `import` From e8eb4d4c279f0b2d48e1b9f15362d79c31ca52d5 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Mon, 13 Nov 2023 10:59:58 +0800 Subject: [PATCH 8/8] Change AboutUs link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a95dd329be..16178e51fff 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp/graph/badge.svg?token=4DBT7T1IUV)](https://codecov.io/gh/AY2324S1-CS2103T-W10-1/tp) -This is a CS2103T project by [AY2324S1-CS2103T-W10-1](https://github.com/AY2324S1-CS2103T-W10-1/tp). It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/). +This is a CS2103T project by [AY2324S1-CS2103T-W10-1](https://ay2324s1-cs2103t-w10-1.github.io/tp/AboutUs.html). It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org/). TAfinder is a desktop app for NUS professors to find and track Teaching Assistant (TA) information. It is optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you are an NUS professor that can type fast, and who is in need of an app to find and manage TA information, TAfinder is the app for you!