Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added UserGuide.md #54

Merged
merged 1 commit into from
Feb 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions UserGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# User Guide
New Features:
- Instructors & Students roles and groups
- Question resolution status

## How to Use and User Testing
To user test, make sure that the following features work as described.
### Instructors & Students roles and groups
The "Instructors" and "Students" groups are created upon installation of the Team Bearries version of NodeBB. Users can be added through the groups dashboard by the admin as desired. When Instructors make posts, their status as instructional staff will be indicated with a badge next to their name. Toggling badges on in the profile menu may be needed for it to display properly. Furthermore, Instructors' posts will be automatically tagged with an `instructor-post` tag.

### Question resolution status
When a Student starts a new topic, this topic will automatically have the `unresolved` tag added in addition to any other selected tags upon posting of the topic. When the topic is replied to by an Instructor, this `unresolved` tag will be removed and a `resolved` tag will be added to the existing topic tags. Student replies will not affect the `unresolved` tag.

## Automated Tests
Automated tests can be found in `tests/topics.js` with the tests assessing topic tags. These tests check the following:
1. If the `unresolved` tag is added when a Student makes post.
2. If the `unresolved` tag is removed when an Instructor replies.
3. If a `resolved` tag is added when an Instructor replies.

These tests ensure that the main topic resolution feature is working as intended.