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

Update AboutUs, PPP, and UG #31

Merged
merged 10 commits into from
Oct 4, 2023
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
21 changes: 5 additions & 16 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

* Role: Integration

### Jean Doe
### Nam Dohyun (Brandon)

<img src="images/johndoe.png" width="200px">
<img src="images/brandon-nam.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](http://github.com/brandon-nam)]
[[portfolio](team/brandon-nam.md)]

* Role: Developer
* Responsibilities: Dev Ops + Threading

### James Doe

<img src="images/johndoe.png" width="200px">

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]

* Role: Developer
* Responsibilities: UI
* Role: Scheduling and Tracking
45 changes: 32 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Shows a message explaning how to access the help page.
Format: `help`


### Adding a person: `add`
### Adding a fosterer: `add`

Adds a fosterer to the address book.

Expand Down Expand Up @@ -109,23 +109,42 @@ Expected output (fail):
Oops! There seems to be an error, please check the format of your command again.
```

### Editing a person : `edit`
### Editing a fosterer's detail : `edit`

Edits an existing person in the address book.
Edits the details of a fosterer stored in the address book.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
**Format**: `edit INDEX`
Alias: `view`

* Edits 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, …​
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
**Parameter**: `INDEX`

Examples:
* `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
* Index of a fosterer to be edited is shown in the list obtained by the find/list command.

**Examples**:
* `list` followed by `edit 3` or `view 3` generates the edit-window for the 3rd fosterer in the address book.

**How to Edit**:
1. Type in `list` command to see the list of fosterers in the address book.
2. Type `edit INDEX` to edit the details of the fosterer with the corresponding INDEX in the list.
3. Type in the command line to search the list of fields, and press enter to edit the first match. This creates a text field around the detail corresponding to the chosen field.
4. Edit the content of the detail and press enter to confirm the changes, or the esc key to cancel them.
5. Repeat step 4-5 until you made all your edits.
6. While the command line is empty, press enter to save all applied changes to all fields, or the esc key to revert them to before the edit command. Both will send you back to the home window.

**Expected Output (success)**:
```
Edit Success!
```

**Expected Output (failure)**:
1. Compulsory fields are not filled in
```
Edit failed: Compulsory fields are not filled in!
```
2. System Error
```
Edit failed: There seems to be an error, please check your fields again.
```
### Listing fosterers: `list`

Lists fosterers that match a particular description or search, or all fosterers if the search is blank.
Expand Down
Binary file added docs/images/brandon-nam.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/team/brandon-nam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: page
title: Brandon's Project Portfolio Page
---

### Project: Foster Family

This is an **animal foster manager** for **non-profit animal shelters** who currently do not have a good logistical workflow to keep track of foster families. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

* **New Feature**:

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=brandon-nam&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22)

* **Project management**:

* **Enhancements to existing features**:

* **Documentation**:
* User Guide:
* Added documentation for the feature `edit`.
* Developer Guide:
* Added implementation details of the `edit` feature.

* **Community**:

* **Tools**:
Loading