Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update repo #3

Merged
merged 45 commits into from
Oct 12, 2023
Merged

Conversation

longnguyentan
Copy link
Owner

No description provided.

longnguyentan and others added 30 commits October 4, 2023 02:01
Update List All Patients and Delete a Patient commands.
Update List All Patients and Delete a Patient commands.
Currently, the "Appendix:Requirements" section is default

To contextualise the Developer Guide to our project, we updated that
portion with the content we currently have.

Update Product Scope, User Stories, Use Cases, NFR and Glossary.
Not all team members have uploaded their AboutUs.md
images and PPP documents.

Each member should upload their respective documents.

Let's add the AboutUs.md image and PPP for wujy28.
Add AboutUs.md image and PPP
Update assigning a patient to a department feature in UserGuide.md
The current README is outdated and written for Addressbook Level 3.

Now that we are using this code base for A&E, we should have the
README reflect this as well.

Let's update the README to be about our application, A&E, instead.
The current User Guide is outdated and still reflects the
features of AB3.

Since we are now using the codebase to develop A&E, we
must update our user guide as such.

Let's
* Update the Viewing Help screenshot to that of A&E's Ui
* Modify the Adding a Person section to Adding a Patient
The current Table of Contents lacks the newly added
section on adding a patient.

Let's add that section to the Table of Contents.
Update UserGuide to include view and edit a patient
Update README.md to suit our application
Update User Guide: Viewing Help and Adding a Patient
AaronJT1 and others added 15 commits October 5, 2023 13:18
Renamed the Person class to Patient

Current, the class is named Person, but in our project, the person we are interested in is Patient.

Rename Person class to Patient class
Rename all instances of Person to Patient
Update model component to rename all Person instance to Patient
Update storage component to rename all Person instance to Patient
Update Ui component to rename all Person instance to Patient
Update test names for all instances of Person to Patient
There are currently some formatting bugs in
documentation like the README, AboutUs, DG, UG and index.
Bugs include invalid hyperlinks, random symbols, inconsistent
headings and grammatical errors.

Fixing these issues can help our documentation come across
as more professional and proper.

Let's
* Fix grammatical issues
* Standardize heading capitalization
* Contextual important parts of the docs to our project
* Fix hyperlink errors
The existing pointers about command under Features
are outdated and contradict other parts of our UG.
The list patients command is in a different format
from the list command of AB3 as well.

Updating the pointers can help our UG be more
consistent. Moreover, changing the list patients
command format from list patients to list can
help us cut down on work from having to change
the user input for that command.

Let's update the features and list command format
in the user guide.
Fix documentation formatting issues
Renamed all instance of Person to Patient
@longnguyentan longnguyentan merged commit aa654a6 into longnguyentan:master Oct 12, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants