Merge pull request AY2324S1-CS2103T-T12-4#24 from ryanongwx/branch-Up…

…dateDocs Branch update docs
Darren159 · Oct 5, 2023 · 73e16d6 · 73e16d6
2 parents 2c451d3 + 73b2191
commit 73e16d6
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 61 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,5 @@ src/test/data/sandbox/
 .DS_Store
 docs/_site/
 docs/_markbind/logs/
+
+/bin/
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -46,9 +46,11 @@ You can reach us at the email `low.darren[at]u.nus.edu`
 * Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Ryan Ong Wei Xian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ryanongwx.png" width = "200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/ryanongwx)]
+[[portfolio](team/ryanongwx.md)]
+* Role: Developer
 
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -384,7 +384,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 **Extensions**
 
-* ~~2a. The given id is invalid.
+* 2a. The given id is invalid.
 
     * 2a1. MedBook shows an error message.~~
 
@@ -408,13 +408,31 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
       Use case ends.
 
+## Use Case: UC08 - Searching for Patients
+
+**Main Success Scenario (MSS)**
+
+1. User initiates a search for patients based on specific keywords using the `search` command.
+2. MedBook performs a case-insensitive search of patient names and details.
+3. MedBook returns a list of patients matching at least one keyword.
+4. The user views the list of matching patients.
+
+**Extensions**
+
+* 3a. No matches found.
+    * 3a1. MedBook displays a message: "No matches found. Try using a different keyword."
+    * Use case ends.
+
+
 *{More to be added}*
 
 ### Non-Functional Requirements
 
 1.  Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
 2.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
 3.  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+4.  The system should be backward compatible with data produced by earlier versions of the system.
+5.  The system should be usable by a novice who has never used an address book.
 
 *{More to be added}*
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -143,23 +143,19 @@ Examples:
 *  `editdetail 2/phone/92345678` Edits the name of the 2nd person to be `92345678`.
 *  `editdetail 3/allergy/aspirin` Edits the allergy of the 3rd person to be `aspirin`.
 
-### Locating persons by name: `find`
+### Locating persons by keywords: `search`
 
-Finds persons whose names contain any of the given keywords.
+In MedBook, the Search functionality streamlines the process of finding patients based on specific keywords. Simply enter the keyword, and MedBook will display a list of patients matching your search criteria. If no matches are found, the system will provide feedback, allowing you to refine your search for better results.
 
-Format: `find KEYWORD [MORE_KEYWORDS]`
+Format: `search [Keyword]`
 
-* The search is case-insensitive. e.g `hans` will match `Hans`
-* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Only the name is searched.
-* Only full words will be matched e.g. `Han` will not match `Hans`
+* The search is case-insensitive. e.g `Penicillin` will match `penicillin`
+* A patient's name and details will be searched.
 * Persons matching at least one keyword will be returned (i.e. `OR` search).
-  e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
+  e.g. `arm fracture` will return `burnt arm`, `leg fracture`
 
 Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`<br>
-  ![result for 'find alex david'](images/findAlexDavidResult.png)
+* `search Penicillin` returns `Penicillin`
 
 ### Deleting a patient : `delete`
 

diff --git a/docs/images/ryanongwx.png b/docs/images/ryanongwx.png
diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md
diff --git a/docs/team/ryanongwx.md b/docs/team/ryanongwx.md
@@ -0,0 +1,20 @@
+---
+  layout: default.md
+  title: "Ryan's Project Portfolio Page"
+---
+
+### Project: MedBook
+
+* **New Feature**:
+
+* **Code contributed**: 
+
+* **Project management**:
+
+* **Enhancements to existing features**:
+
+* **Documentation**:
+
+* **Community**:
+
+* **Tools**: