Skip to content

Commit

Permalink
Merge pull request #1 from jovantanyk/master
Browse files Browse the repository at this point in the history
docs: init documentation
Update initial AboutUs and UserGuide documentation
  • Loading branch information
jovantanyk authored Feb 25, 2024
2 parents b896eb0 + 733a435 commit caf9d27
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 26 deletions.
34 changes: 13 additions & 21 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,9 @@ We are a team based in the [School of Computing, National University of Singapor

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

## Project team
## ImmuniMate Project Team

### John Doe

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

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]

* Role: Project Advisor

### Jane Doe
### Alex Setyawan

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

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

### Johnny Doe
### Tan Jovan

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

[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
[[homepage](http:/jovantanyk.dev)]
[[github](https://github.com/jovantanyk)]
[[portfolio](team/johndoe.md)]

* Role: Developer
* Responsibilities: Data
* Responsibilities: Front-end, Documentation

### Jean Doe

### Lanyu

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

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

* Role: Developer
* Responsibilities: Dev Ops + Threading
* Responsibilities: Data

### James Doe
### Natalie Leong

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

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

* Role: Developer
* Responsibilities: UI
* Responsibilities: Dev Ops + Threading
6 changes: 3 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
layout: page
title: User Guide
---

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.
## Introduction
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.

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

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

* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
layout: page
title: AddressBook Level-3
title: ImmuniMate
---

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

![Ui](images/Ui.png)

**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).
**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.

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

0 comments on commit caf9d27

Please sign in to comment.