diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 673cc040d4f..5a3578d8db9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -16,6 +16,8 @@ Let’s begin and get you up to speed with AgentAssist! -------------------------------------------------------------------------------------------------------------------- +
+ # Table of Contents 1. [Introduction](#1-introduction) @@ -40,6 +42,7 @@ Let’s begin and get you up to speed with AgentAssist! 7. [Known Issues](#7-known-issues) 8. [Command Summary](#8-command-summary) +
# 1. Introduction ## 1.1 What is AgentAssist? @@ -62,6 +65,8 @@ Maximize your productivity, minimize your response time, and amplify your sales -------------------------------------------------------------------------------------------------------------------- +
+ # 2. Important Prerequisites Before you start using AgentAssist, there are a few prerequisites to ensure you get the most out of the application: @@ -77,6 +82,9 @@ AgentAssist allows you to manage client data like names, phone numbers, emails, 🎉 **By meeting these prerequisites, you'll be ready to make the most of AgentAssist’s fast, keyboard-driven interface and powerful data management features.** 🎉 +-------------------------------------------------------------------------------------------------------------------- +
+ # 3. Getting Started Welcome to AgentAssist. Here’s how to get up and running quickly and easily. @@ -109,45 +117,39 @@ Move the .jar file you downloaded into this folder. ### Step 4: Run the Application 1. **Open a command terminal** - - On Windows, press `Windows Key + R`, type `cmd`, and press `Enter`. - - On macOS, press `Command + Space`, type `Terminal`, and press `Enter`. - - On Linux, open your **Terminal** application from the system menu. + - **Windows**: press `Windows Key + R`, type `cmd`, and press `Enter`. + - **macOS**: press `Command + Space`, type `Terminal`, and press `Enter`. + - **Linux**: open your **Terminal** application from the system menu. + 2. **Navigate your terminal to the folder where you saved the AgentAssist application:** - - To do this, use the `cd` command followed by the path to your folder.\ - > ℹ️ **Tip:** Follow the guide below to navigate to your folder in the terminal: - > - >
Click here to learn how to navigate to your folder in terminal - > - > - **Windows**: Use the command `cd `. - For example, if **AgentAssist** is stored in the `Downloads` folder: - > ```bash - > cd C:\Users\\Downloads - > ``` - > - > - **macOS/Linux**: Use the command `cd `. - For example, if **AgentAssist** is stored in the `Downloads` folder: - > ```bash - > cd /Users//Downloads - > ``` - > - >
- -3. Run the application: - - Type the following command: **`java -jar agentassist.jar`** and press **Enter**. - - A window similar to the below image should appear in a few seconds. You will see a graphical user interface with sample contact information already added.

- ![Ui](images/Ui.png) + - In the terminal, type: `cd ` and press **Enter**. (Replace with the actual location of AgentAssist.) + - For example, if **AgentAssist** is stored in your **Downloads** folder: + - **Windows**: `cd C:\Users\\Downloads` + - **macOS/Linux**: `cd /Users//Downloads` + + +3. **Run the application:** + - In the terminal, type: `java -jar agentassist.jar` and press **Enter**. + - After a few seconds, a window similar to the below image should appear. This is the AgentAssist interface, with sample contact information already loaded for you to explore.
+ UI + 4. 🎉 **Congratulations! AgentAssist is now up and running!** 🎉 - You're all set to start using AgentAssist to manage your contacts, track your sales, and boost your productivity! + You're all set to start using AgentAssist to manage your contacts, track your sales, and boost your productivity. + +
## 3.2 Graphical User Interface (GUI) Layout +UISplitView To learn more about how to use commands in AgentAssist, proceed to the next section. -------------------------------------------------------------------------------------------------------------------- +
+ # 4. Understanding Commands in AgentAssist {#using-agentassist} The true power of **AgentAssist** lies in efficiently using commands. Before diving into specific commands, let’s break down the basic structure of a command. @@ -160,7 +162,7 @@ Let's take a look at the structure in more detail: | **Components** | **Description** | **Example** | |:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------| | **Command** | The action you want AgentAssist to perform. | `add` | -| **Flag(s)** | Modifiers that specify what kind of data is being handled.

Flag(s) are typically 1-2 letters followed by a backslash. | `n/`, `p/`, `r/`, `rn/` | +| **Flag(s)** | Modifiers that specify what kind of data is being handled.

Flag(s) are typically 1-2 letters followed by a backslash. | `n/`, `e/`, `r/`, `rn/` | | **Argument(s)** | The values or inputs the command uses, such as client data or specific details.

This guide may represent it as a placeholder using ``. | `John Doe`, `john@example.com` | Here's an example that uses multiple flags and arguments: @@ -191,7 +193,9 @@ Here is a reference table that briefly summarizes available commands: | `help` | Displays a list of available commands and their usage. | | `exit` | Exits the AgentAssist application. | -Refer to the [Commands Section](#commands-section) for more comprehensive details of each command. +Refer to the [Commands Section](#5-commands) for more comprehensive details of each command. + +
## 4.3 Flags @@ -217,6 +221,8 @@ Here’s a reference table of available flags and the type of data they correspo > > Flags are typically derived from the first letter of their corresponding data type (e.g., `n/` for `name`), making them easy to remember! +
+ ## 4.4 Arguments Arguments are the values that follow each flag in a command. **Arguments cannot be empty**, and each must meet specific parsing and format requirements to ensure proper execution of the command. @@ -242,6 +248,8 @@ Refer to the table below for more details. > > Providing a flag without an accompanying argument will result in an error and prevent the command from executing properly. +
+ ## 4.5 Using Commands To get started, simply type a command into the command box and hit **Enter**. @@ -271,7 +279,7 @@ Some initial commands to try: The GUI will dynamically update to show the results of your commands, making it easy to see the impact of your actions in real time. -Refer to the [Commands Section](#commands-section) for more comprehensive details of each command. +Refer to the [Commands Section](#5-commands) for more comprehensive details of each command. > 💡 **Pro Tip:** > Combine commands like `filter` followed by `edit` or `delete` to manage your contacts more effectively. @@ -279,6 +287,8 @@ Refer to the [Commands Section](#commands-section) for more comprehensive detail -------------------------------------------------------------------------------------------------------------------- +
+ # 5. Commands ## 5.1 How to Read Commands @@ -313,9 +323,9 @@ add n/ p/ e/ a/
j/ i/ [t/ p/ e/ a/
j/ i/ [t/ ] [rn/ ] - ``` +``` +add n/ p/ e/ a/
j/ i/ [t/ ] [rn/ ] +``` * Mandatory Fields: `n/`, `p/`, `e/`, `a/`, `j/`, `i/` * Optional Fields: `t/`, `rn/` @@ -380,25 +390,25 @@ For detailed explanations of each flag and acceptable arguments, refer to Sectio **Examples:** - Edit only 1 specific field: - ``` - edit 12 a/ Ridge View Residential College - ``` - ``` - edit 12 t/ gold - ``` + ``` + edit 12 a/ Ridge View Residential College + ``` + ``` + edit 12 t/ gold + ``` - Edit multiple fields at the same time: - ``` - edit 12 p/ 99887766 e/ mrtan_newemail@ntu.sg j/ unemployed i/ 0 t/ reject - ``` + ``` + edit 12 p/ 99887766 e/ mrtan_newemail@ntu.sg j/ unemployed i/ 0 t/ reject + ``` - Append new remark onto existing one: - ``` - edit 12 ra/ Recently received Gordon E. Moore Award - ``` + ``` + edit 12 ra/ Recently received Gordon E. Moore Award + ``` - Replace all remark(s) with a new remark: - ``` - edit 69 rn/ Do not call, angry about calls - ``` + ``` + edit 69 rn/ Do not call, angry about calls + ``` **What to Expect:** - **On Success:** @@ -434,13 +444,13 @@ For detailed explanations of each flag and acceptable arguments, refer to Sectio **Examples:** - Remove a client with a specific index (e.g. at index 12): - ``` - delete 12 - ``` + ``` + delete 12 + ``` Confirmation prompt: - ``` - This will permanently delete this contact. Are you sure you want to execute this command? (y/n) - ``` + ``` + This will permanently delete this contact. Are you sure you want to execute this command? (y/n) + ``` **What to Expect:** - **On Success (after confirming with y/yes):** @@ -610,9 +620,9 @@ view index **Examples:** - **View client no.1** - ``` - view 1 - ``` + ``` + view 1 + ``` This will open a split view showing detailed information for the client at index 1. **What to Expect:** @@ -695,6 +705,8 @@ The data in AgentAssist is automatically saved as a [JSON](https://developer.moz -------------------------------------------------------------------------------------------------------------------- +
+ ## 6. FAQ ### How do I transfer my data to another Computer? @@ -718,6 +730,7 @@ Each credit card tier is visually distinguished in the UI: Gold is marked with a -------------------------------------------------------------------------------------------------------------------- + ## 8. Command Summary | **Action** | **Command Format** | **Example** | diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss index 0d3f6e80ced..cc3b4c06304 100644 --- a/docs/_sass/minima/_base.scss +++ b/docs/_sass/minima/_base.scss @@ -142,7 +142,7 @@ blockquote { border-left: 4px solid $brand-color-light; padding-left: $spacing-unit / 2; @include relative-font-size(1.125); - font-style: italic; + font-style: default; > :last-child { margin-bottom: 0; @@ -165,6 +165,10 @@ code { border: 1px solid $brand-color-light; border-radius: 3px; background-color: $code-background-color; + margin-top: 0.25em; + white-space: pre-wrap; + overflow-wrap: break-word; + word-break: break-word; } code { diff --git a/docs/_sass/minima/_layout.scss b/docs/_sass/minima/_layout.scss index ca99f981701..9f430364741 100644 --- a/docs/_sass/minima/_layout.scss +++ b/docs/_sass/minima/_layout.scss @@ -176,8 +176,8 @@ .post-content { margin-bottom: $spacing-unit; - h1, h2, h3 { margin-top: $spacing-unit * 2 } - h4, h5, h6 { margin-top: $spacing-unit } + h1 { margin-top: $spacing-unit * 2 } + h2, h3, h4, h5, h6 { margin-top: $spacing-unit * 1.15 } h2 { @include relative-font-size(1.75); diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 9c7099520b0..758edc5fad1 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ diff --git a/docs/images/UiSplitView.png b/docs/images/UiSplitView.png new file mode 100644 index 00000000000..da63f607d6e Binary files /dev/null and b/docs/images/UiSplitView.png differ diff --git a/docs/index.md b/docs/index.md index 16467ce7a4b..af139771400 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ title: AgentAssist [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) -![Ui](images/Ui.png) +![UiSplitView](images/UiSplitView.png) **AgentAssist is a desktop application, designed for banking sales agents to help with managing their contact details.**