Add servicereview

servicereview.md

@@ -0,0 +1,46 @@
+# ServiceReview Cog
+
+The ServiceReview cog provides a simple, standalone command for users to submit reviews for staff members or services. It is designed to be used at any time, independent of any ticket system, and sends all submissions to a designated channel for administrative review.
+
+---
+
+## 1. Features
+
+-   **Form-Based Submissions:** Uses a Discord Modal (pop-up form) to collect detailed, structured feedback from users.
+-   **Standalone Functionality:** Allows users to submit reviews without needing an active ticket, making it a flexible feedback tool.
+-   **DataManager Integration:** Logs the timestamp of submitted reviews, making it compatible with the `DataManager` cog for automatic data purging.
+-   **Hybrid Commands:** All commands are fully hybridized, working with both slash commands (`/`) and your bot's prefix (`[p]`).
+
+---
+
+## 2. User Workflow
+
+1.  A user runs the `/srev` command in any channel.
+2.  The bot presents the user with a "Service Review" pop-up form.
+3.  The user fills out the fields: "Service Type," "Rating," "Review Text," and "Toxicity Level."
+4.  Upon submission, the bot formats the review into a clean embed.
+5.  The embed is sent to the configured review channel for staff to see.
+6.  The user receives a private confirmation that their review has been submitted.
+
+---
+
+## 3. User Commands
+
+### `/srev`
+
+Opens the Service Review submission form.
+
+**Prefix Version:** `[p]srev`
+
+---
+
+## 4. Admin Commands
+
+### `/srevset`
+
+The main command group for configuring the ServiceReview system. Requires `Manage Server` permissions.
+
+**Prefix Version:** `[p]srevset`
+
+-   `/srevset channel <#channel>`
+    -   Sets the channel where new service reviews will be sent. This is a **required** setup step.