From 4a1f80eca036cfed9347f2ddddc257c2af218311 Mon Sep 17 00:00:00 2001 From: Noelle Wang <73260931+No767@users.noreply.github.com> Date: Sun, 7 Jan 2024 14:47:33 -0800 Subject: [PATCH] Clean and remove stale references (#38) --- README.md | 3 +-- docs/index.rst | 1 - docs/user-guide/features.rst | 30 ++++++++++-------------------- 3 files changed, 11 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index fb9520f..c6e1389 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,7 @@ The process is extremely similar to ModMail, but with major differences. When a sends a direct message to the bot, Rodhaj will create a new ticket (which is a forum post) internally for staff to view. From there, each ticket is tied with a member and DMs from Rodhaj will be processed and sent to their respective tickets. -To ensure that staff will be able to respond, each active staff is randomly assigned -to a particular ticket. This ensures that tickets are evenly distributed among staff. Staff are free to swap and work on multiple tickets as needed. Once a ticket is closed, the staff will be automatically unassigned from the ticket, and a new DM to Rodhaj will prompt the user to create a new ticket. It's designed to be a replacement to ModMail. +Staff are free to swap and work on multiple tickets as needed. Once a ticket is closed, the staff will be automatically unassigned from the ticket, and a new DM to Rodhaj will prompt the user to create a new ticket. In short, it's designed to be a replacement to ModMail. ## Contributing diff --git a/docs/index.rst b/docs/index.rst index d2e03e9..70d61c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,7 +27,6 @@ Features Rodhaj offers these features in addition to ones found on ModMail: - Advanced tags system -- Automatic ticket assignment (with manual override) - Modern touch using forum channels, webhooks, and best practices - Customizable settings diff --git a/docs/user-guide/features.rst b/docs/user-guide/features.rst index df9c0a6..980242e 100644 --- a/docs/user-guide/features.rst +++ b/docs/user-guide/features.rst @@ -18,7 +18,8 @@ The ticket will be marked as closed to the user and subsequently closed on the t Once closed, a ticket cannot be reopened. If a staff uses the ``?close`` command, the active ticket will be closed and the user will be notified of the closure. -Note that there is no plans to support timed closures, as it is a design feature fudmentally flawed for this type of command. +Note that there is no plans to support timed closures, +as it is a design feature fudmentally flawed for this type of command. Administrative Features ======================= @@ -26,15 +27,17 @@ Administrative Features Replying -------- -In order to reply to a thread, use the ``?reply`` command. This will send a message to the user within an active ticket. -Without executing this command, all messages will be seen as internal in the ticket. Images attachments, emojis, and stickers -are supported. +In order to reply to a thread, use the ``?reply`` command. +This will send a message to the user within an active ticket. +Without executing this command, all messages will be seen as internal in the ticket. +Images attachments, emojis, and stickers are supported. .. note:: - Unlike ModMail, **none** of the messages sent with the ``?reply`` command, internally in the ticket, or by the user to staff - will be logged. This is to ensure that the privacy of the user is respected. Staff can always look back at an closed ticket - within the ticket channel if they need to refer to a particular message. + Unlike ModMail, **none** of the messages sent with the ``?reply`` command, internally in the ticket, + or by the user to staff will be logged. This is to ensure that the privacy of the user is respected. + Staff can always look back at an closed ticket within the ticket channel if they need to refer + to a particular message. Tags ---- @@ -42,16 +45,3 @@ Tags To aid with frequent responses, tags can be used. Tags do not have an owner associated, thus they can be used and edited by any staff member. Tags can be used by using the ``?tag `` command, where ```` represents the name of the tag that should be used. By default, they are sent directly to the user who is in the ticket, but can be sent internally by using the ``--ns`` flag. - - -Ticket Assignee ---------------- - -As tickets are created, they are assigned to a staff member. This is done to ensure that the ticket is not left unattended. -The ticket assignee is randomly selected from the staff members who are online. If no staff members are online, then there will not be a ticket assignee. -In order to manually assign a ticket, the ``?assign`` command can be used. This will assign the ticket to the staff member who executed the command. - -When the ticket is created, the staff is notified in a channel that logs events related to tickets. This is done to ensure that the staff is aware of the ticket -and can act accordingly. - -