Skip to content

Commit

Permalink
Merge pull request AY2324S1-CS2103T-F12-4#176 from qz1004/update-docs3
Browse files Browse the repository at this point in the history 
Fix parameter tables
  • Loading branch information
@LoMaply
LoMaply authored Nov 13, 2023
2 parents 4223143 + 9131ea9 commit 932bfd8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,9 @@ ___

## Contact Commands


### Contact Parameters
| Parameter | Description​ | Examples​ |
| Parameter | Description | Examples |
|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
| `NAME` | The name of the contact. <br/> <br/> It should only contain alphanumeric characters and spaces, and it should not be blank. | <ul><li>`John Doe`</li><li>`Miguel-James Lee`</li></ul> |
| `PHONE` | The phone number of the contact. <br/> <br/> It must contain only numbers, and be at least 3 digits long. | <ul><li>`999`</li><li>`91243253`</li></ul> |
Expand All @@ -143,6 +144,7 @@ ___
| `TAG` | The tag you want to associate with the contact, if any. A contact can have more than 1 tag. <br/> <br/> It must be alphanumeric, i.e. special and non-alphanumeric characters (including spaces) are not allowed. | <ul><li>`Friend`</li><li>`TermLife`</li></ul> |
| `CONTACT_INDEX` | The number shown beside each contact's name in the displayed contacts list. <br/> <br/> It must be a positive integer and not more than the total number of contacts. | <ul><li>`1`</li></ul> |


### Adding a contact: `addc`

Adds a contact to OutBook.
Expand Down Expand Up @@ -262,6 +264,8 @@ Examples:

- Meetings are allowed to overlap and multiple meetings can be occurring at the same time.

</div>

### Meeting Parameters

| Parameter | Description | Examples |
Expand All @@ -275,8 +279,6 @@ Examples:
| `MEETING_INDEX` | The number shown beside each meeting's title in the displayed meetings list. <br/> <br/> It must be a positive integer and not more than the total number of meetings. | <ul><li>`1`</li></ul> | |


</div>

### Adding a meeting: `addm`

Adds a meeting to OutBook.
Expand Down
8 changes: 5 additions & 3 deletions docs/team/qz1004.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: Qi Zhen's Project Portfolio Page

### Project: OutBook

OutBook is a desktop data management application for freelance insurance agents to manage their numerous contacts and meeting schedule. Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.
OutBook is a desktop application designed for freelance insurance agents, enabling them to effectively organize and oversee their extensive contacts and meeting schedules. It is optimised for Command Line Interface (CLI) and aims to significantly reduce the time needed for organizational tasks.


My contributions to the project are listed below

Expand Down Expand Up @@ -33,10 +34,11 @@ My contributions to the project are listed below

- **Documentation**:
- User Guide:
- Modified documentation for `addc`, `findc` and `addmc`
- Updated documentation for `addc`, `findc` and `addmc`
- Added table of contents
- Added tables that summarise contact and meeting parameters
- Added tables to summarise contact and meeting parameters
- Documented the sections 'Key Features' and 'Navigating OutBook'
- General editing to ensure uniformity and coherence
- Developer Guide:
- Added implementation details of the `addmc` command
- Added implementation details of the `Status` field for `Person`

0 comments on commit 932bfd8

Please sign in to comment.