Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/update-dg-assets' into update-dg…
Browse files Browse the repository at this point in the history
…-assets
  • Loading branch information
aureliony committed Apr 15, 2024
2 parents 92bd666 + abbd1a7 commit ee9e9a8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
10 changes: 2 additions & 8 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@

--------------------------------------------------------------------------------------------------------------------

## **Acknowledgements**

_{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }_

--------------------------------------------------------------------------------------------------------------------

## **Setting up, getting started**

Refer to the guide [_Setting up and getting started_](SettingUp.md).
Expand Down Expand Up @@ -843,5 +837,5 @@ Team size: 5
6. **Add sharper colour contrast between assets and tags**: Currently, tags and assets have a very similar color scheme, making it harder for users to differentiate them. In future versions, we will add more visual clarity tags and assets.
7. **Make duplicate checking more robust**: The application enforces distinct contacts, but the user may add the same contact twice unintentionally (e.g. entering `dave tan` and `Dave Tan`). We plan to make duplicate checking more robust and potentially warn the user first for such cases.
8. **Add a `remark` command**: At present users can only add additional information to contacts using tags. We plan to allow the user to add more detailed information like notes using a `remark` command.
9. **Add command shortcuts and suggestions**: Currently, there is no support for any shortcuts or suggestions of commands to aid both experienced and new users. We plan to add command shortcuts and suggestions to make the application easier to use for all users.
10. **Make phone number validation more robust**: Currently, we perform little validation on the phone number to allow for inputs such as `2555 (ext)` for the user's convenience. This however means that inputs such as `+++` may be accepted. We plan to improve phone number validation without restricting the user.
9. **Add command suggestions**: Currently, there is no support for any auto-complete suggestions for commands, that would aid both experienced and new users. We plan to add an auto-complete feature, that would display what command the user is likely typing in a separate pop-up, the ability to press `tab` to quickly complete the command word, and what fields they are missing.
10. **Make phone number validation more robust**: Currently, we perform little validation on the phone number to allow for inputs such as `2555, 232` for the user's convenience. This however means that inputs such as `+++` would be accepted, which is unlikely to be the user's intention. We plan to improve phone number validation without restricting the user in the future.
5 changes: 2 additions & 3 deletions docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@
* [Introduction]({{ baseUrl }}/UserGuide.html#introduction)
* [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
* [Features]({{ baseUrl }}/UserGuide.html#features)
* [FAQ]({{ baseUrl }}/UserGuide.html#faq)
* [Command Summary]({{ baseUrl }}/UserGuide.html#faq)
* [FAQ]({{ baseUrl }}/UserGuide.html#frequently-asked-questions)
* [Command Summary]({{ baseUrl }}/UserGuide.html#command-summary)
* [Glossary]({{ baseUrl }}/UserGuide.html#glossary)
* [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded:
* [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#acknowledgements)
* [Setting Up]({{ baseUrl }}/DeveloperGuide.html#setting-up-getting-started)
* [Design]({{ baseUrl }}/DeveloperGuide.html#design)
* [Implementation]({{ baseUrl }}/DeveloperGuide.html#implementation)
Expand Down

0 comments on commit ee9e9a8

Please sign in to comment.