Skip to content

Commit

Permalink
Merge pull request AY2324S2-CS2103T-T15-1#224 from Kappaccinoh/updateFAQ
Browse files Browse the repository at this point in the history
update FAQ and known issues
  • Loading branch information
Alteqa authored Apr 12, 2024
2 parents 49b7f46 + 4f16bd6 commit 98b055d
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,11 +399,45 @@ Furthermore, certain edits can cause the mediCLI to behave in unexpected ways (e
**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous MediCLI home folder.

**Q**: Can I use MediCLI on different operating systems?<br>
**A**: Yes, MediCLI is compatible with multiple operating systems as long as you have Java 11 or above installed. You can run it on Windows, macOS, or Linux.

**Q**: Is there a limit to the number of patients, doctors, or appointments I can add to MediCLI?<br>
**A**: There is no built-in limit to the number of entries you can add to MediCLI. However, the performance may be affected if you add an extremely large number of entries.

**Q**: Can I customize the appearance or theme of the interface in MediCLI?<br>
**A**: Currently, there is no option to customize the appearance or theme of the interface in MediCLI. It has a default interface optimized for efficiency and usability.

**Q**: Does MediCLI support multi-user access or user authentication?<br>
**A**: No, MediCLI is designed for single-user access only. It does not have built-in support for multi-user access or user authentication.

**Q**: Can I export data from MediCLI to other formats like CSV or Excel?<br>
**A**: Currently, there is no built-in feature to export data from MediCLI to other formats. However, you can manually extract data from the JSON file if needed.

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

## Known issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
1. **Issue**: When using multiple screens, if the MediCLI application is moved to a secondary screen and later switched to using only the primary screen, the graphical user interface (GUI) may open off-screen upon application launch.

**Impact**: Users may find it challenging to interact with the application as the GUI is rendered off-screen, making it inaccessible and difficult to use.

**Workaround**: To resolve this issue, users can delete the preferences.json file generated by the application before launching MediCLI again. This action resets the application preferences, ensuring that the GUI opens within the visible area of the primary screen.
2. **Issue**: MediCLI may experience performance degradation when handling a large number of entries, such as patients, doctors, or appointments.

**Impact**: Users may notice slower response times or delays when adding, editing, or deleting entries, especially in cases with a large dataset.

**Workaround**: Users can optimize performance by limiting the number of entries stored in MediCLI or by periodically archiving old data to reduce the dataset size.
3. **Issue**: Editing data directly in the data file may lead to unexpected behavior or data corruption.

**Impact**: Users who manually edit the JSON data file used by MediCLI may inadvertently introduce errors or inconsistencies, resulting in data loss or application crashes.

**Workaround**: It's recommended to avoid directly editing the data file unless absolutely necessary. Users should exercise caution and make backups before making any changes to the data file.
4. **Issue**: MediCLI does not provide built-in data export functionality to formats like CSV or Excel.

**Impact**: Users may face challenges when trying to export data from MediCLI for analysis or reporting purposes, especially if they rely on external tools or software that require specific file formats.

**Workaround**: Users can manually extract data from the JSON data file used by MediCLI and convert it to the desired format using third-party tools or scripts. Alternatively, they can explore custom export solutions or request this feature from the developers.

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

Expand Down

0 comments on commit 98b055d

Please sign in to comment.