Skip to content

Commit

Permalink
Merge pull request #201 from ravern/issue-clean-up
Browse files Browse the repository at this point in the history
Fix "not sure what command" box hyperlinks
  • Loading branch information
ravern authored Nov 13, 2023
2 parents 3cfad87 + e8eb4d4 commit fcb652c
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 27 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

[![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://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!

![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)!
10 changes: 5 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -118,11 +118,11 @@ Some example commands you can try:

<div markdown="block" class="alert alert-secondary">

**:bulb: Not sure what the commands above does?**
**:bulb: Not sure what the commands above do?**

You can find all about the usable commands [here](#2-features),<br>
look at a summary of all the usable commands [here](#72-command-summary),<br>
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

</div>

Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ 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)

**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**
Expand Down

0 comments on commit fcb652c

Please sign in to comment.