From fa035e2825036ae8b17f46e3cb085d90f98ebb91 Mon Sep 17 00:00:00 2001
From: Leon <82466943+LeonTheDev-io@users.noreply.github.com>
Date: Fri, 4 Jul 2025 23:42:42 +0200
Subject: [PATCH] docs: add documentation for avgRating placeholder
---
docs/configuration/categories/index.md | 1 +
docs/self-hosting/configuration.md | 3 +++
2 files changed, 4 insertions(+)
diff --git a/docs/configuration/categories/index.md b/docs/configuration/categories/index.md
index d5606e4..e6f1178 100644
--- a/docs/configuration/categories/index.md
+++ b/docs/configuration/categories/index.md
@@ -135,6 +135,7 @@ Use this to provide and ask for information, such as stating what is expected of
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
| `{num}`
`{number}` | The ticket's number, unique across all categories in the server |
| `{name}`
`{username}` | The ticket creator's username |
+| `{avgRating}` | The average rating given by users for tickets in this category |
| `{avgResponseTime}` | The time between tickets being opened and receiving their first response from a staff member (only in the current category) |
| `{avgResolutionTime}` | The time between tickets being opened and being closed (only in the current category) |
diff --git a/docs/self-hosting/configuration.md b/docs/self-hosting/configuration.md
index c3dee28..8ad4f16 100644
--- a/docs/self-hosting/configuration.md
+++ b/docs/self-hosting/configuration.md
@@ -227,6 +227,8 @@ If it doesn't exist, run the bot and it will be generated for you.
type: 3
- name: "{avgResponseTime} response time"
type: 3
+ - name: "{avgRating} ⭐ rating"
+ type: 3
interval: 20
status: online
stats: true
@@ -284,6 +286,7 @@ An array of activities (length must be at least 1).
The activity name, which may contain these placeholders:
+- `#!yaml {avgRating}`
- `#!yaml {avgResolutionTime}`
- `#!yaml {avgResponseTime}`
- `#!yaml {guilds}`