Skip to content

Commit 733a435

Browse files
committed
docs: init documentation
Update AboutUs, UserGuide, Index.md to reflect team
1 parent b896eb0 commit 733a435

File tree

3 files changed

+18
-26
lines changed

3 files changed

+18
-26
lines changed

docs/AboutUs.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,9 @@ We are a team based in the [School of Computing, National University of Singapor
77

88
You can reach us at the email `seer[at]comp.nus.edu.sg`
99

10-
## Project team
10+
## ImmuniMate Project Team
1111

12-
### John Doe
13-
14-
<img src="images/johndoe.png" width="200px">
15-
16-
[[homepage](http://www.comp.nus.edu.sg/~damithch)]
17-
[[github](https://github.com/johndoe)]
18-
[[portfolio](team/johndoe.md)]
19-
20-
* Role: Project Advisor
21-
22-
### Jane Doe
12+
### Alex Setyawan
2313

2414
<img src="images/johndoe.png" width="200px">
2515

@@ -29,31 +19,33 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
2919
* Role: Team Lead
3020
* Responsibilities: UI
3121

32-
### Johnny Doe
22+
### Tan Jovan
3323

3424
<img src="images/johndoe.png" width="200px">
3525

36-
[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
26+
[[homepage](http:/jovantanyk.dev)]
27+
[[github](https://github.com/jovantanyk)]
28+
[[portfolio](team/johndoe.md)]
3729

3830
* Role: Developer
39-
* Responsibilities: Data
31+
* Responsibilities: Front-end, Documentation
4032

41-
### Jean Doe
33+
34+
### Lanyu
4235

4336
<img src="images/johndoe.png" width="200px">
4437

45-
[[github](http://github.com/johndoe)]
46-
[[portfolio](team/johndoe.md)]
38+
[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
4739

4840
* Role: Developer
49-
* Responsibilities: Dev Ops + Threading
41+
* Responsibilities: Data
5042

51-
### James Doe
43+
### Natalie Leong
5244

5345
<img src="images/johndoe.png" width="200px">
5446

5547
[[github](http://github.com/johndoe)]
5648
[[portfolio](team/johndoe.md)]
5749

5850
* Role: Developer
59-
* Responsibilities: UI
51+
* Responsibilities: Dev Ops + Threading

docs/UserGuide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
layout: page
33
title: User Guide
44
---
5-
6-
AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
5+
## Introduction
6+
As government databases grow, information management might prove complex for civil servants, especially so for personal data. **ImmuniMate** offers a way to record comprehensive information about every contact, while ensuring timely updates and avoiding duplications/contradictions. It also seeks to establish links between contacts for speedier information retrieval.
77

88
* Table of Contents
99
{:toc}
@@ -52,7 +52,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
5252
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
5353

5454
* Items with ``​ after them can be used multiple times including zero times.<br>
55-
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
55+
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
5656

5757
* Parameters can be in any order.<br>
5858
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: page
3-
title: AddressBook Level-3
3+
title: ImmuniMate
44
---
55

66
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
77
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
88

99
![Ui](images/Ui.png)
1010

11-
**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
11+
**ImmuniMate is a desktop application aimed at General Practitioners and Healthcare Professionals**. The application intends to assist users in managing patient information, and tracking potential infectious.
1212

1313
* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
1414
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.

0 commit comments

Comments
 (0)