Skip to content

Commit

Permalink
✨ Threads can be auto archived
Browse files Browse the repository at this point in the history
- In managing suggestions, reference threads can be created automatically
  • Loading branch information
acollierr17 committed Jan 28, 2023
1 parent d7c8b4e commit 7d36a96
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ You can either view if thread channels are automatically created or not when a s

<SuggestionThreadMessage />

At this time, threads are not automatically archived when suggestions are approved and rejected, so you will have to moderate this manually.
When approving or rejecting a thread, you can opt to have the thread automatically be archived via the [auto archive threads](#auto-archive-threads) configuration.

## Keep Suggestion Logs

Expand All @@ -84,3 +84,8 @@ When enabled, this configuration allows a suggestion to remain in the channel wh
Usage `/config get config:Anonymous suggestions` (to view) or `/config anonymous <enable|disable>`

When enabled, this configuration allows users to optionally submit a suggestion as anonymous, omitting any of their profile infomation from the suggestion. Read more about this feature [here](anonymous-suggestions.mdx).

## Auto Archive Threads
When enabled, this configuration allows the bot to automatically archive suggestions threads when resolved (approved or rejected).

Usage `/config get config:Auto archive threads` (to view) or `/config auto_archive_threads <enable|disable>`
7 changes: 6 additions & 1 deletion docs/managing-suggestions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import SuggestionStatusEmbed from '@site/src/components/Embeds/SuggestionStatusE
`|` = Means "or"
`administrator` = A user with the **Manage Server** permission

## Overview
Managing suggestions is simple. Each suggestion is assigned a **Suggestion ID** \(sID\). From there, staff members can either approve, reject, or add a note to a suggestion with the sID. The sID is located in the footer of each suggestion:

<SuggestionEmbedMessage
Expand All @@ -38,6 +39,9 @@ Alternatively, you can use the message ID of the suggestion message to manage a

However, you won't have to worry too much about trying to remember IDs. The bot will autocomplete the suggestion ID as you type it out!

### Suggestion Threads
If enabled, you can have the bot [automatically create threads](configuration.mdx#suggestion-thread-channels) when a new suggestion is submitted as well as have them [automatically archived](configuration.mdx#auto-archive-threads) when a suggestion is approved or rejected. View the respective configuration sections for more information.

## Slash Command Permissions

If you haven't already done so, please refer to the [Getting Started](intro.md#setting-up-the-bot) section to set up slash command permissions. By default, only administrators can manage suggestions. However, if you want other staff members to have access to these commands, please refer to the aforementioned section.
Expand All @@ -62,7 +66,8 @@ Suggestions are approved via either the sID or message ID. Once you have it, run
- The suggestion will update as "Approved" in the suggestions channel and its results will be logged.
- The user will receive a DM that you approved their suggestion.
- The results of that suggestion will be posted to the suggestion logs channel.
- _An optional response can be added by running_ `/approve <sID|message ID> [response]`.
- If a response has been added via `/approve <sID|message ID> [response]`, that will be displayed in the results message.
- If the suggestion has a thread attached, it'll automatically be archived if enabled in the [configuration](configuration.mdx#auto-archive-threads).

<SuggestionEmbedMessage
embed={<SuggestionStatusEmbed status="approved" />}
Expand Down

0 comments on commit 7d36a96

Please sign in to comment.