Skip to content

Commit

Permalink
Update UserGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
galishaq authored Oct 20, 2024
1 parent 5c56448 commit 4910743
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,21 +154,22 @@ Below are the files that contain automated tests for the resources page feature,
**Why the tests are sufficient:** The tests cover the main use cases for the search function, the tests handle various edge cases for the queries, asserts are used to comapre the query results with the expected results, and console logging assists in displaying the functionality.


### 3.User Guide for Bug/Feedback Form and Bug Archive Features

## 3.User Guide for Bug/Feedback Form and Bug Archive Features

---

### Overview
## Overview

This guide will walk you through using the bug/feedback form submission and bug archive feature within the admin dashboard. These features allow you to submit feedback or bug reports and access an archive of all previously submitted bugs if you are an admin. The system ensures both functionalities work smoothly and provide meaningful feedback when errors occur.

---

### How to Use the Bug/Feedback Form Submission Feature
## How to Use the Bug/Feedback Form Submission Feature

The Bug/Feedback form is designed for all users to submit issues or feedback directly through a simple interface.

#### **Steps to Submit a Bug/Feedback:**
### **Steps to Submit a Bug/Feedback:**

1. **Navigate to the Bug/Feedback Form:**
- On the left sidebar look for the "Submit Bug/Feedback" button.
Expand All @@ -187,19 +188,19 @@ The Bug/Feedback form is designed for all users to submit issues or feedback dir
4. **Close the Form:**
- Or if you changed your mind about submitting bugs you can press the red “Close” button to close the form.

#### **Key Features:**
### **Key Features:**

- **Validation**: The system ensures that all fields (title, description) are filled out correctly.
- **Security**: The CSRF token ensures your form submissions are protected from cross-site request forgery.
- **Alerts**: Success or failure alerts inform users of the submission result.

---

### How to Use the Bug Archive Page
## How to Use the Bug Archive Page

The Bug Archive Page allows administrators to view previously submitted bugs and feedback, providing an organized list of entries.

#### **Steps to Access the Bug Archive:**
### **Steps to Access the Bug Archive:**

1. **Navigate to the Bug Archive Page:**
- First click the “Admin” button in the left sidebar, clilc it, and login if you are an admin.
Expand All @@ -220,11 +221,11 @@ The Bug Archive Page allows administrators to view previously submitted bugs and

---

### 3. User Testing Guide
## 3. User Testing Guide

Here’s how you, the user, can manually test these features:

#### **Bug/Feedback Form Testing:**
### **Bug/Feedback Form Testing:**

1. **Basic Form Submission:**
- Navigate to the bug form, enter valid input for all fields, and submit.
Expand Down

0 comments on commit 4910743

Please sign in to comment.