Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt to fix broken User Guide hyperlinks #261

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Don’t let another special occasion slip by uncelebrated. Sign up for 'Flirt an
## Quick Start

1. Ensure you have Java `11` or above installed in your Computer.
2. Download the latest version of `Flirt and Fork` from [here](http://link.to/FlirtandFork).
2. Download the latest version of `Flirt and Fork` from [here](https://github.com/AY2324S2-CS2113-T11-2/tp/releases).
3. Copy the file to the folder you want to use as the _home folder_
4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar Flirt_and_Fork.jar` command to run the bot. The GUI should appear in a few seconds.
5. Type the command in the command box and press Enter to execute it.
6. Refer to the [Features](#Features) section below for an overview of all valid commands.
6. Refer to the [Features](#features-) section below for an overview of all valid commands.

### Warning
Do NOT manually tamper with the .txt files in the data folder - `Flirt and Fork` will refuse to cooperate with you if you choose to violate this rule.
Expand Down Expand Up @@ -68,7 +68,7 @@ Extra commands to facilitate application use.
There is only one command to terminate the program:
- `exit`: Saves all current data and exits the program.

Refer to the [Usage](#Usage) section below for details of each command.
Refer to the [Usage](#usage) section below for details of each command.

## Usage

Expand Down Expand Up @@ -457,7 +457,7 @@ The itinerary selected will be based off the user's indicated location and budge

Format: `itinerary [PREFERRED_LOCATION], [PREFERRED_PRICE]`

> Note: The `preferred location` and `preferred price` must be within the [legend](#Legend).
> Note: The `preferred location` and `preferred price` must be within the [legend](#legend).
> Ensure the formatting is strictly followed, including the spacing and the capitalisation for preferred location and preferred price.
> For example, ``itinerary E, A` will be registered, whereas `itinerary E,A` or `itinerary e, a` will result in an error.
Example of usage: `itinerary E, A`
Expand Down Expand Up @@ -524,7 +524,7 @@ Adds a new restaurant to your favourites list.

Format: `food [name of eatery], [LOCATION], [PRICE], [CUISINE]`

> Note: The `location` and `price` must be within the [legend](#Legend).
> Note: The `location` and `price` must be within the [legend](#legend).
> Repeated food entries are allowed to be added to favourites. We understand that franchises like Mcdonalds and KFC do not have unique names for their respective branches, and thus we will consider them as separate entries. For example, 'food KFC, E, C, W' could be used to represent both the KFC branch at Pasir Ris Park and at East Coast Park. The responsibility is on the user to ensure that the naming convention used allows him/her to clearly differentiate the food
> For the name of eatery, commas are not allowed. Kindly omit commas used. For example, `food Steak, Burgers and Cocktail Bar, C, S, J` should be replaced with `food Steak Burgers and Cocktail Bar, C, S, J`
> Ensure the formatting is strictly followed, including the spacing and the capitalisation for location, price and cuisine.
Expand All @@ -547,7 +547,7 @@ Adds a new activity to your favourites list.

Format: `activity [name of activity], [LOCATION], [PRICE]`

> Note: The `location` and `price` must be within the [legend](#Legend).
> Note: The `location` and `price` must be within the [legend](#legend).
> Repeated activity entries are allowed to be added to favourites. We understand that common activities like cycling or swimming do not have unique names, and thus we will consider them as separate entries. For example, 'activity cycling, E, C' could be used to represent both cycling at Pasir Ris Park and cycling at East Coast Park. The responsibility is on the user to ensure that the naming convention used allows him/her to clearly differentiate the activity
> For the name of activity, commas are not allowed. Kindly omit commas used. For example, `activity Bizad Run, 2024 Version, C, S` should be replaced with `activity Bizad Run 2024 Version, C, S`
> Ensure the formatting is strictly followed, including the spacing and the capitalisation for location and price.
Expand Down
3 changes: 2 additions & 1 deletion docs/team/seandooa.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ Here are the enhancements I implemented
- Helped with maintaining the issue tracker.

### Review/mentoring contributions
- Authored several PR reviews
- Helped some team members with learning how to use shadowJar
- Try to reply immediately whenever team members are asking for assistance in the group chat.
- Reply as soon as possible whenever team members are asking for assistance in the group chat, providing helpful advice or solving the problem alongside them.

## Contributions beyond the project team
- Highlighted 7-8 non-trivial bugs for the team I was assigned to during the PE dry run. This ranged from serious issues with the User Guide pdf formatting to feature flaws. Also gave advice on not merging PRs that do not pass the GitHub checks since merged PRs with failed checks could be seen on their User Guide.
Expand Down
Loading