Skip to content

Commit 5aec394

Browse files
friedrice231friedrice231
authored andcommitted
Add User Guide README.md to /docs and the associated screenshot of PawPal
1 parent e9f4af9 commit 5aec394

File tree

2 files changed

+111
-14
lines changed

2 files changed

+111
-14
lines changed

docs/README.md

Lines changed: 111 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,127 @@
1-
# Duke User Guide
1+
# PawPal Chat Assistant - User Guide
22

3-
// Update the title above to match the actual product name
3+
Welcome to **PawPal**, your friendly chat assistant for managing tasks efficiently! 🐾 This guide will help you get started with using PawPal and its features.
44

5-
// Product screenshot goes here
5+
---
66

7-
// Product intro goes here
7+
## 📌 Table of Contents
8+
1. [Introduction](#introduction)
9+
2. [Getting Started](#getting-started)
10+
3. [Features](#features)
11+
- [Adding Tasks](#adding-tasks)
12+
- [Listing Tasks](#listing-tasks)
13+
- [Marking Tasks as Done](#marking-tasks-as-done)
14+
- [Deleting Tasks](#deleting-tasks)
15+
- [Task Types](#task-types)
16+
4. [Command Summary](#command-summary)
17+
5. [FAQ](#faq)
18+
6. [Troubleshooting](#troubleshooting)
819

9-
## Adding deadlines
20+
---
1021

11-
// Describe the action and its outcome.
22+
## 🐱 Introduction
23+
PawPal is a simple, interactive chatbot that helps you manage your daily tasks with ease. Whether it’s tracking tasks, setting deadlines, or organizing your schedule, PawPal is here to assist you with a purr-sonalized experience!
1224

13-
// Give examples of usage
25+
![PawPal Screenshot](/docs/Ui.png)
26+
---
1427

15-
Example: `keyword (optional arguments)`
28+
## 🚀 Getting Started
1629

17-
// A description of the expected outcome goes here
30+
1. **Run PawPal**: Open the application on your device.
31+
2. **Start Chatting**: Type your commands in the chatbox and hit "Send" or press "Enter".
32+
3. **Manage Tasks**: Add, list, and complete your tasks easily.
1833

34+
---
35+
36+
## ✨ Features
37+
38+
### 📋 Adding Tasks
39+
You can add different types of tasks:
40+
- **ToDos**: Simple tasks without deadlines.
41+
- **Deadlines**: Tasks with a specific due date.
42+
- **Events**: Tasks that occur within a time range.
43+
44+
💡 **Example Commands:**
45+
```plaintext
46+
todo read
47+
deadline test /by tomorrow
48+
event test /from today /to tomorrow
49+
```
50+
51+
### 📃 Listing Tasks
52+
View all your tasks using the `list` command.
53+
💡 **Example:**
54+
```plaintext
55+
list
1956
```
20-
expected output
57+
PawPal will display your tasks in a structured format.
58+
59+
### ✅ Marking Tasks as Done
60+
Once you’ve completed a task, mark it as done!
61+
💡 **Example:**
62+
```plaintext
63+
done 1
64+
```
65+
This marks task #1 as completed.
66+
67+
### 🗑️ Deleting Tasks
68+
Remove a task from your list using the delete command.
69+
💡 **Example:**
70+
```plaintext
71+
delete 2
2172
```
73+
This removes task #2 from your task list.
74+
75+
### 🏷️ Task Types
76+
- **`[T]`**: ToDo task
77+
- **`[D]`**: Deadline task
78+
- **`[E]`**: Event task
79+
- **`[X]`**: Completed task
80+
81+
Example of listed tasks:
82+
```plaintext
83+
1. [T][X] run
84+
2. [T][ ] read
85+
3. [D][ ] test (by: tomorrow)
86+
4. [E][ ] test from: today to: tomorrow
87+
```
88+
89+
---
90+
91+
## 📜 Command Summary
92+
93+
| Command | Description | Example |
94+
|---------|-------------|---------|
95+
| `todo <task>` | Adds a ToDo task | `todo read` |
96+
| `deadline <task> /by <date>` | Adds a Deadline task | `deadline test /by tomorrow` |
97+
| `event <task> /from <date> /to <date>` | Adds an Event task | `event test /from today /to tomorrow` |
98+
| `list` | Lists all tasks | `list` |
99+
| `done <task number>` | Marks a task as done | `done 1` |
100+
| `delete <task number>` | Deletes a task | `delete 2` |
101+
102+
---
103+
104+
## ❓ FAQ
105+
106+
**Q1: How do I edit a task?**
107+
Currently, PawPal does not support editing tasks. You can delete and re-add a task instead.
108+
109+
**Q2: Can I undo a completed task?**
110+
No, but you can re-add the task if needed.
111+
112+
**Q3: What happens if I enter an invalid command?**
113+
PawPal will notify you and prompt you to enter a valid command.
22114

23-
## Feature ABC
115+
---
24116

25-
// Feature details
117+
## 🔧 Troubleshooting
26118

119+
| Issue | Possible Cause | Solution |
120+
|-------|--------------|----------|
121+
| Task is not marked as done | Incorrect task number | Check the task list and try again |
122+
| Command not recognized | Typo or incorrect format | Refer to the [Command Summary](#command-summary) |
123+
| Task not deleted | Task number does not exist | Use `list` to check task numbers |
27124

28-
## Feature XYZ
125+
---
29126

30-
// Feature details
127+
PawPal is here to help you stay organized in a fun and interactive way! 🐾 Happy task managing! 🎉

docs/Ui.png

44.8 KB
Loading

0 commit comments

Comments
 (0)