Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ZweZeya committed Nov 11, 2024
1 parent e136a6f commit 41410d6
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 55 deletions.
34 changes: 17 additions & 17 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ In this case, `AddressBookParser` creates `AddCommandParser` to parse user input
If any of the above constraints are violated, `AddressBookParser` throws a ParseException. Otherwise, it creates a new instance of `AddCommand` that corresponds to the user input.
`AddCommand` comprises of the internship application to be added, which is an instance of `InternshipApplication`.

Upon execution, `AddCommand` first queries the supplied model if it contains a duplicate internship application. If no duplicate internship application exists, `AddCommand` then calls on `model::addItem` to add the internship application into the data.
Upon execution, `AddCommand` first queries the supplied model if it contains a duplicate internship application. If no duplicate internship application exists, `AddCommand` then adds the internship application into the data.


### List all internship applications
Expand Down Expand Up @@ -323,7 +323,6 @@ The implementation of the command follows the convention of a normal command, wh

`AddressBookParser` creates `ExitCommand`
Upon execution, `ExitCommand` gets encapsulates the intent to close the application in `CommandResult`.
`MainWindow` checks for the intent via `isExit`, after which, it calls `handleExit` to close the application.

> **_NOTE:_** `Model` is not invoked here but included for the sake of clarity.
Expand Down Expand Up @@ -359,22 +358,23 @@ Upon execution, `ExitCommand` gets encapsulates the intent to close the applicat

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that …​ |
|----------|-------------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------|
| `* * *` | CS Undergraduate | list all the internship applications | I can view all my past applications |
| `* * *` | Forgetful CS Undergraduate | have a link to HireMe's help page | I can see all the different commands that I can use |
| `* * *` | An efficient CS Undergraduate | type the commands | I do not have to lift my fingers off the keyboard |
| `* * *` | CS Undergraduate | add an internship application | I can add on to the records of all the internships I have applied to |
| `* * *` | CS Undergraduate | delete an internship application | I can remove invalid or irrelevant applications |
| `* * *` | CS Undergraduate | save the internship application data locally | I will not lose my data when I exit the application |
| `* * *` | CS Undergraduate | load the internship from a saved file | I can get back my data when I open the application |
| `* * *` | CS Undergraduate | clear the list of internship application I have saved | I can restart a new list in the next internship application cycle |
| `* * *` | CS Undergraduate | find internship applications by company name | I can quickly locate specific applications for review or updates |
| Priority | As a …​ | I want to …​ | So that …​ |
|----------|-------------------------------|----------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| `* * *` | CS Undergraduate | list all the internship applications | I can view all my past applications |
| `* * *` | Forgetful CS Undergraduate | have a link to HireMe's help page | I can see all the different commands that I can use |
| `* * *` | An efficient CS Undergraduate | type the commands | I do not have to lift my fingers off the keyboard |
| `* * *` | CS Undergraduate | add an internship application | I can add on to the records of all the internships I have applied to |
| `* * *` | CS Undergraduate | delete an internship application | I can remove invalid or irrelevant applications |
| `* * *` | CS Undergraduate | save the internship application data locally | I will not lose my data when I exit the application |
| `* * *` | CS Undergraduate | load the internship from a saved file | I can get back my data when I open the application |
| `* * *` | CS Undergraduate | clear the list of internship application I have saved | I can restart a new list in the next internship application cycle |
| `* * *` | CS Undergraduate | find internship applications by company name | I can quickly locate specific applications for review or updates |
| `* * *` | CS Undergraduate | update the status of an internship application to accepted, pending, or rejected | I can update the status of each application accurately |
| `* *` | Meticulous CS Undergraduate | sort the list of internship applications by date of application | I can prioritize follow-ups with older applications |
| `*` | Organised CS Undergraduate | view the interview dates for different internships applications | I can update my schedule accordingly |
| `*` | Efficient CS Undergraduate | view my most desired internship applications by favouriting them | I can prioritize my time on checking up on these internship applications |
| `*` | Forgetful CS Undergraduate | remind myself of acceptance deadline | I will not miss the deadline to accept |
| `* *` | Meticulous CS Undergraduate | sort the list of internship applications by date of application | I can prioritize follow-ups with older applications |
| `* *` | Curious CS Undergraduate | see a chart that summarises the statuses of all my applications | I know know the breakdown of each status |
| `*` | Organised CS Undergraduate | view the interview dates for different internships applications | I can update my schedule accordingly |
| `*` | Efficient CS Undergraduate | view my most desired internship applications by favouriting them | I can prioritize my time on checking up on these internship applications |
| `*` | Forgetful CS Undergraduate | remind myself of acceptance deadline | I will not miss the deadline to accept |

*{More to be added}*

Expand Down
27 changes: 19 additions & 8 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,19 @@ For steps 5 and 6, refer to **either** [Mac Users](#_mac-users_) **or** [Windows
Continue to [Using the terminal](#_using-the-terminal_) after completing steps 5 and 6.

#### _Mac Users_
5. Use mac search and type Terminal, click on open.
5. Use mac spotlight search (Command + Space bar) and type Terminal, click on open.

<img src="images/MacTerminal.png" alt="macsterminal" width="700"/>

You will see a window like this.
6. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar hireme.jar` command to run the application.<br>

![openmacterminal](images/OpenMacTerminal.png)

6. Click into the folder created in step 3. Left click on the `hireme.jar` file and select `Get Info`.
![macfilepathinfo](images/Macfilepathinfo.png)

On the new open that pops up, left click on `Where` and copy the file path.
<img src="images/Macfilepath.png" alt="macfilepath" width="300"/>

#### _Windows Users_
5. Use windows search and type Terminal, click on open.
Expand All @@ -134,6 +144,7 @@ You will see a window like this.
- Windows Terminal:
![windowscd](images/Windowscd.png)
- Mac Terminal:
![maccd](images/Maccd.png)
<br>

#### _Using the HireMe application_
Expand Down Expand Up @@ -213,7 +224,7 @@ Examples:
</div>

<box type="info" seamless>
**Note:** HireMe considers an entry to be a duplicate of all of its fields match **(case-insensitive)** an existing internship application entry. An attempt to add duplicates will result in an error.
<strong>Note:</strong> HireMe considers an entry to be a duplicate of all of its fields match <strong>(case-insensitive)</strong> an existing internship application entry. An attempt to add duplicates will result in an error.
</box>


Expand Down Expand Up @@ -301,17 +312,17 @@ Use these commands to update the status of a specified internship application to
5. `/list` followed by `/accept 4` when there are only 3 internship applications returns an error message.

---

<box type="info" seamless>
**Note:**<br> You can update an application’s status to its current state. For example, using `/accept INDEX` on an already accepted application will keep its status as `ACCEPTED`, `/pending INDEX` on a pending application will keep it as `PENDING`, and `/reject INDEX` on a rejected application will maintain its `REJECTED` status.
</box>

<p>Before and after images of the first example</p>
<div style="display: flex;">
<img src="images/accept-status-before.png" width="350" alt="Accept-Status-Before" style="margin-right: 20px;">
<img src="images/accept-status-after.png" width="350" alt="Accept-Status-After">
</div>

<box type="info" seamless>
<strong>Note:</strong><br> You can update an application’s status to its current state. For example, using `/accept INDEX` on an already accepted application will keep its status as `ACCEPTED`, `/pending INDEX` on a pending application will keep it as `PENDING`, and `/reject INDEX` on a rejected application will maintain its `REJECTED` status.
</box>


<br></br>

### Filtering internship applications by status: `/filter`
Expand Down
8 changes: 1 addition & 7 deletions docs/diagrams/AddSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,7 @@ deactivate AddressBookParser
LogicManager -> AddCommand : execute(m)
activate AddCommand

AddCommand -> Model : hasItem(internship)
activate Model

Model --> AddCommand
deactivate Model

AddCommand -> Model : addItem(internship)
AddCommand -> Model : add if it is not a duplicate
activate Model

Model --> AddCommand
Expand Down
25 changes: 2 additions & 23 deletions docs/diagrams/ExitSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
!include style.puml
skinparam ArrowFontStyle plain

box Ui UI_COLOR_T1
participant ":MainWindow" as MainWindow UI_COLOR
end box

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
Expand All @@ -17,10 +13,7 @@ box Model MODEL_COLOR_T1
participant "m:Model" as Model MODEL_COLOR
end box

[-> MainWindow : executeCommand("/exit)
activate MainWindow

MainWindow-> LogicManager : execute("/exit")
[-> LogicManager : execute("/exit")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("/exit")
Expand Down Expand Up @@ -49,24 +42,10 @@ deactivate CommandResult
ExitCommand --> LogicManager : r
deactivate ExitCommand

LogicManager --> MainWindow : r
[<--LogicManager : r
deactivate LogicManager
'Hidden arrow to position the destroy marker below the end of the activation bar.
ExitCommand -[hidden]-> LogicManager
destroy ExitCommand

MainWindow -> CommandResult : isExit()
activate CommandResult

CommandResult --> MainWindow : isExit
deactivate CommandResult

alt isExit
MainWindow -> MainWindow : handleExit()
activate MainWindow
deactivate MainWindow
end

[<--MainWindow
deactivate MainWindow
@enduml
Binary file added docs/images/MacTerminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Maccd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Macfilepath.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Macfilepathinfo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/OpenMacTerminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 41410d6

Please sign in to comment.