Skip to content

Commit

Permalink
Merge pull request #201 from ZShunRen/dg-dev
Browse files Browse the repository at this point in the history
Add planned enhancements section to dg
  • Loading branch information
ZShunRen authored Nov 7, 2024
2 parents ce4d3a0 + aae47a0 commit 1245e72
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

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

[[github](http://github.com/colinhia)]
[[github](http://github.com/colinhia)]
[[portfolio](http://github.com/colinhia)]

* Role: Developer
Expand Down
34 changes: 29 additions & 5 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,11 +233,35 @@ The following activity diagram summarizes what happens when a user executes a ne
* Pros: Will use less memory (e.g. for `delete`, just save the client being deleted).
* Cons: We must ensure that the implementation of each individual command are correct.

_{more aspects and alternatives to be added}_
## **Planned enhancements**

### \[Proposed\] Data archiving
### 1. Multi-Language Support
**Current Issue:** Non-English text input can cause visual bugs, including reversed text display.

**Proposed Solution:** Replace the default system font with a universal font that supports multiple languages. See [this reference](https://stackoverflow.com/questions/42854957/javafx-strange-space-characters-in-arabic) for implementation details.

### 2. Support for Forward Slash in Names
**Current Issue:** Names containing forward slashes (e.g., "Ramesh s/o Ravichandran") are incompatible with `add`, `edit`, and `filter` commands due to two problems:

1. The parser misinterprets "s/o" as a Status flag command, resulting in an invalid status error
2. The name validation regex explicitly blocks forward slashes to prevent parsing conflicts

**Technical Impact:**
- Allowing forward slashes would create ambiguous parsing scenarios
- Example of resulting error message:
![Confusing error message](images/PlannedEnhancementBug1.png)

**Status:** Implementation deferred to a future release due to the complexity of potential solutions and risk of introducing new bugs.

### 3. Data Import/Export Functionality
**Current issue:** Users must manually copy and paste the `agentassist.json` file in the `data` directory, if they wish to use others' agentassist data files, or share their data files with other users.

**Proposed Enhancement:** Add UI buttons in the application menu for:
- Importing data files
- Exporting data files

**Status:** Scheduled for future release as current manual process provides a workable solution.

_{Explain here how the data archiving feature will be implemented}_


--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -308,9 +332,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

1. User requests to list clients.
2. AgentAssist shows a list of clients.
3. User requests to delete a specific client in the list.
3. User requests to delete a specific client in the list.
4. AgentAssist asks user for confirmation.
5. User confirms.
5. User confirms.
6. AgentAssist deletes the client.

Use case ends.
Expand Down
24 changes: 11 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ Let’s begin and get you up to speed with AgentAssist!
1. [Introduction](#1-introduction)
2. [Important Prerequisites](#2-important-prerequisites)
3. [Getting Started](#3-getting-started)
- 3.1 [Installation](#31-installation)
- 3.1 [Installation](#31-installation)
- 3.2 [Graphical User Interface (GUI) Layout](#32-graphical-user-interface-gui-layout)
4. [Understanding Commands in AgentAssist](#4-understanding-commands-in-agentassist)
- 4.1 [Command Structure Overview](#41-command-structure-overview)
- 4.2 [Commands](#42-commands)
- 4.1 [Command Structure Overview](#41-command-structure-overview)
- 4.2 [Commands](#42-commands)
- 4.3 [Flags](#43-flags)
- 4.4 [Arguments](#44-arguments)
- 4.4 [Arguments](#44-arguments)
- 4.5 [Using Commands](#45-using-commands)
5. [Commands](#5-commands)
- 5.1 [How to Read Commands](#51-how-to-read-commands)
- 5.2 [Data Modification Commands](#52-data-modification-commands)
- 5.3 [Data Filtering Commands](#53-data-filtering-commands)
- 5.4 [General Commands](#54-general-commands)
- 5.5 [Saving Data](#55-saving-data)
- 5.3 [Data Filtering Commands](#53-data-filtering-commands)
- 5.4 [General Commands](#54-general-commands)
- 5.5 [Saving Data](#55-saving-data)
- 5.6 [Modifying the Data File](#56-modifying-the-data-file)
6. [FAQ](#6-faq)
7. [Known Issues](#7-known-issues)
Expand Down Expand Up @@ -115,8 +115,7 @@ Download the latest version of the `.jar` file from the AgentAssist [repository]

### Step 3: Choose a Folder

Find or create a folder on your computer where you want to store the AgentAssist application and its data.
Move the .jar file you downloaded into this folder.
Find or create a folder on your computer where you want to store the AgentAssist application and its data. Move the .jar file you downloaded into this folder.

### Step 4: Run the Application

Expand All @@ -139,8 +138,7 @@ Move the .jar file you downloaded into this folder.
<img src="images/Ui.png" alt="UI" style="margin-top: 20px; margin-bottom: 20px;">


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.
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.

<div style="page-break-after: always;"></div>

Expand Down Expand Up @@ -289,7 +287,7 @@ The GUI will dynamically update to show the results of your commands, making it
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.
> Combine commands like `filter` followed by `edit` or `delete` to manage your contacts more effectively.
> For example, use `filter j/doctor` to display all doctors, then `edit 2 a/321 New Address` to update the address for the second listed doctor.
[↑ Return to Table of Contents](#table-of-contents)
Expand Down Expand Up @@ -379,7 +377,7 @@ For detailed explanations of each flag and acceptable arguments, refer to Sectio
```

> **Note on Duplicates:**
>
> AgentAssist will prevent duplicate entries if a client with t``he **same name, email and phone number** is already saved.
> When this happens, you will see the following message:
>
Expand Down
Binary file added docs/images/PlannedEnhancementBug1.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 1245e72

Please sign in to comment.