Merge pull request #201 from leeianee/branch-documentation

Update Documentation
AY2223S1-CS2103T-T14-1 · Nov 7, 2022 · 93dfb17 · 93dfb17
2 parents 5461e7b + 10704ac
commit 93dfb17
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -34,7 +34,7 @@ We are a team based in the [School of Computing, National University of Singapor
 [[github](https://github.com/leeianee)] [[portfolio](team/leeianee.md)]
 
 * Role: Developer
-* Responsibilities: Code Quality
+* Responsibilities: `Add` command, User guide, Developer Guide
 
 ### Marcus Isaac Goh Wei Jie
 
@@ -54,4 +54,4 @@ We are a team based in the [School of Computing, National University of Singapor
 [[portfolio](team/puakii.md)]
 
 * Role: Developer
-* Responsibilities: `find` command, refactoring from `Person` to `Internship`, user guide and developer guide
+* Responsibilities: `Find` command, refactoring from `Person` to `Internship`, user guide and developer guide
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -629,9 +629,9 @@ Similar to use case 4 except that the filtering is done by application status in
 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 internship applications 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. Should be more efficient than a typical spreadsheet application.
-   1. Should be easy to pick up for people who are not proficient with technology.
-5. Should be able to work without any internet connection.
+4. Should be more efficient than a typical spreadsheet application. 
+5. Should be easy to pick up for people who are not proficient with technology.
+6. Should be able to work without any internet connection.
 
 ### Glossary
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -258,6 +258,7 @@ Below shows the command format used in FindMyIntern.
   * e.g. if `help 123` is entered, it will be interpreted as `help`
 </div>
 </div>
+<div style="page-break-after: always;"></div>
 
 ### Commands
 
@@ -563,6 +564,16 @@ Filters for internship applications of the specified [application status](#appli
 
 * `APPLICATION_STATUS` is case-insensitive.
 
+<div class="d-flex alert alert-info">
+<div class="me-3">
+  <span class="badge text-bg-info">INFO</span>
+</div>
+<div markdown="span">
+**Usage of <code>filter</code> command**<br>
+<code>filter</code> command filter internship applications from the original list instead of the current list.
+</div>
+</div>
+
 <div class="d-flex alert alert-info">
 <div class="me-3">
   <span class="badge text-bg-info">INFO</span>