Skip to content

[Documentation:Forum] Live Lecture Chat Documentation #684

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

Merged
merged 3 commits into from
Jun 19, 2025
Merged
Show file tree
Hide file tree
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
25 changes: 25 additions & 0 deletions _docs/instructor/course_settings/live_chat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
category: Instructor > Course Settings
title: Live Chat
---

See also [Student -- Communication -- Live Chat](/student/communication/live_chat).

## Enabling Live Chat

To enable Live Chat for a course, an instructor must go to the "Course Settings" page and click the checkbox labelled "Enable Live Chat". You can then access Live Chat from the left sidebar. When you enter the Live Chat menu, you will be shown a list of currently enabled and disabled chats:

![](/images/live_chat/live_chat_menu_admin.png)

To create a new chat, click the New Chatroom button and enter your desired name, description, and anonymity (the description may be blank):

![](/images/live_chat/live_chat_creation.png)


You will then see your newly created channel, and you will be able to click Start Session to allow students to join the chat. Additionally, you can edit the Live Chat or delete the Live Chat if the chat is disabled.

![](/images/live_chat/live_chat_edit.png)

An instructor can join the chatroom and leave messages while it is enabled or disabled:

![](/images/live_chat/live_chat_instructor_access.png)
27 changes: 27 additions & 0 deletions _docs/student/communication/live_chat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
category: Student > Communication
title: Live Chat
---

The live chat feature allows Submitty users to engage in real time communication via their course page. Its primary use case is to allow for live participation within lectures, creating a similar ease of communication to an online lecture.

## Live Chat Usage

Once your instructor has enabled Live Chat, it will appear on the sidebar for student use:

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

Upon clicking on Live Chat, you will be met with this menu:

![](/images/live_chat/live_chat_menu.png)

When an instructor enables live chat, a chat entry will appear. Your instructor may have enabled the ability to join Anonymously as shown below:

![](/images/live_chat/live_enabled_chat.png)

You can now enter Live Chat. There you will see messages from other Submitty users in your course:

![](/images/live_chat/live_chat.png)


See also [Instructor -- Course Settings -- Live Chat](/instructor/course_settings/live_chat).
Binary file added images/live_chat/live_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_icon_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_instructor_access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_chat_menu_admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/live_chat/live_enabled_chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ var NAVTREE =
] ],
[ "Communication", "/student/communication/forum", [
[ "Discussion Forum", "/student/communication/forum", null ],
[ "Live Chat", "/student/communication/live_chat", null ],
[ "Office Hours Queue", "/student/communication/office_hours_queue", null ],
[ "Writing Markdown", "/student/communication/markdown", null ]
] ]
Expand All @@ -83,6 +84,7 @@ var NAVTREE =
[ "Course Settings", "/instructor/course_settings/index", [
[ "Overview", "/instructor/course_settings/index", null ],
[ "Discussion Forum", "/instructor/course_settings/forum", null ],
[ "Live Chat", "/instructor/course_settings/live_chat", null ],
[ "Submini Polling", "/instructor/course_settings/submini_polls", null ],
[ "Office Hours Queue", "/instructor/course_settings/queue", null ],
[ "Grade Inquiries", "/instructor/course_settings/grade_inquiries", null ],
Expand Down
Loading