Skip to content

chore: autofix docs formatting #147

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.

Sign up for GitHub

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
github-actions merged 1 commit into from
Jul 6, 2026
Merged

chore: autofix docs formatting #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions docs/custom-bot/modules/community/birthday.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,13 @@ The configuration is organized into tabs in the dashboard - the rows below are g

### Pre-Birthday Notifications

| Field | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable pre-birthday notifications? | If enabled, the bot posts a notification in the birthday channel a configurable number of days before each user's birthday. |
| Field | Description |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable pre-birthday notifications? | If enabled, the bot posts a notification in the birthday channel a configurable number of days before each user's birthday. |
| (optional) Pre-Birthday-Channel | _Only visible if pre-birthday notifications are enabled._ Optional separate channel for pre-birthday reminders. If empty, they are sent to the notification channel (if set) or otherwise the birthday channel. Use this to keep pre-birthday reminders apart from the actual "Happy birthday" messages. |
| Pre-birthday lead times (days) | _Only visible if pre-birthday notifications are enabled._ List of lead times (in days) before a birthday at which to post a notification. For example, `[1, 7]` sends a notification both 7 days and 1 day before the birthday. |
| Pre-birthday message | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did not provide a birth year. The `%days%` placeholder gives the number of days remaining. |
| Pre-birthday message with age | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did provide a birth year. Supports the `%age%` placeholder for the age the user will turn. |
| Pre-birthday lead times (days) | _Only visible if pre-birthday notifications are enabled._ List of lead times (in days) before a birthday at which to post a notification. For example, `[1, 7]` sends a notification both 7 days and 1 day before the birthday. |
| Pre-birthday message | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did not provide a birth year. The `%days%` placeholder gives the number of days remaining. |
| Pre-birthday message with age | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did provide a birth year. Supports the `%age%` placeholder for the age the user will turn. |

### Commands

Expand Down
76 changes: 38 additions & 38 deletions docs/custom-bot/modules/moderation/anti-nuke.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/scnx-api/scnx-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ Format: `text/plain`. Consists of three components in a string:
1. The timestamp the response was generated
2. A "," character
3. The actual JSON-Body (see table below)
| Key | Description |
| ---- | --- |
| event | Name of the event or request |
| guildID? | ID of the associated guild |
| body | Body of the request, depending on the event type |
| Key | Description |
| -------- | ------------------------------------------------ |
| event | Name of the event or request |
| guildID? | ID of the associated guild |
| body | Body of the request, depending on the event type |

### Installation Events

Expand Down
4 changes: 2 additions & 2 deletions docs/support-bot/ai-faq/pre-ticket-gatekeeper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ If a member picks a topic that has a [form](/docs/support-bot/general/forms) att

Which topics the gatekeeper screens is controlled in two layers: a **global default** and a **per-topic override**.

**Global default** - on the AI FAQ settings page, under **Default for topics**:
**Global default** - on the AI FAQ settings page, under **Default for topics**:

- **Screen all topics by default** _(default)_ - the gatekeeper runs on every topic unless a topic opts out.
- **Don't screen topics by default** - the gatekeeper runs on no topic unless a topic opts in. Handy when you only want the AI on a few high-volume topics (like a general "Question" topic) and want everything else to behave normally.

**Per-topic override** - on each topic's settings page (Ticket Topics for [Modmail](https://scnx.app/glink?page=support-system/modmail/ticket-topics) or the [Ticket System](https://scnx.app/glink?page=support-system/ticket-system/ticket-topics)), the **AI gatekeeper for this topic** option lets you override the default for that one topic:
**Per-topic override** - on each topic's settings page (Ticket Topics for [Modmail](https://scnx.app/glink?page=support-system/modmail/ticket-topics) or the [Ticket System](https://scnx.app/glink?page=support-system/ticket-system/ticket-topics)), the **AI gatekeeper for this topic** option lets you override the default for that one topic:

- **Follow global default** - uses whichever default you picked above.
- **Always screen with AI** - the gatekeeper always runs on this topic.
Expand Down
108 changes: 54 additions & 54 deletions docs/support-bot/feature-comparison.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ The SCNX Support Bot offers four support systems. You can enable any combination

## At a glance {#at-a-glance}

| | Modmail | Ticket System | Forum Support | Voice Support |
| ------------------------------ | -------------------- | ---------------------- | ---------------------------- | ----------------------- |
| **How members reach you** | DM the bot | Click a button | Post in a public forum | Join a voice channel |
| **Visibility** | Private | Private channel | **Public thread** | Private voice |
| **Conversation style** | Text (relayed) | Text (in a channel) | Text (in the open) | Live voice |
| **Built-in AI first answer** | ➖ (via AI FAQ) | ➖ (via AI FAQ) | ✅ | ❌ |
| **Shared queue & claiming** | ✅ | ✅ | ✅ | ✅ (pull next) |
| **Auto-close & SLA reminders** | ✅ | ✅ | ✅ | ➖ |
| **Feedback & star ratings** | ✅ | ✅ | ✅ | ✅ |
| **Analytics & wait-time** | ✅ | ✅ | ✅ | ✅ |
| **Best for** | Private 1:1 help | Structured private tickets | Public, reusable answers | Real-time voice help |
| **Availability** | All Support Bot plans | All Support Bot plans | Early-access preview | Early-access preview |
| | Modmail | Ticket System | Forum Support | Voice Support |
| ------------------------------ | --------------------- | -------------------------- | ------------------------ | -------------------- |
| **How members reach you** | DM the bot | Click a button | Post in a public forum | Join a voice channel |
| **Visibility** | Private | Private channel | **Public thread** | Private voice |
| **Conversation style** | Text (relayed) | Text (in a channel) | Text (in the open) | Live voice |
| **Built-in AI first answer** | ➖ (via AI FAQ) | ➖ (via AI FAQ) | ✅ | ❌ |
| **Shared queue & claiming** | ✅ | ✅ | ✅ | ✅ (pull next) |
| **Auto-close & SLA reminders** | ✅ | ✅ | ✅ | ➖ |
| **Feedback & star ratings** | ✅ | ✅ | ✅ | ✅ |
| **Analytics & wait-time** | ✅ | ✅ | ✅ | ✅ |
| **Best for** | Private 1:1 help | Structured private tickets | Public, reusable answers | Real-time voice help |
| **Availability** | All Support Bot plans | All Support Bot plans | Early-access preview | Early-access preview |

:::info Legend
✅ supported  ·  ❌ not supported  ·  ➖ not applicable to how this system works
Expand All @@ -46,54 +46,54 @@ The detailed tables below compare the three **text-based** systems in depth. **V

## Messaging & communication

| | Modmail | Ticket System | Forum Support |
| ---------------------------------------------------------- | :-----: | :-----------: | :-----------: |
| Conversation happens directly in a channel/thread | ❌ | ✅ | ✅ |
| Messages relayed via DM | ✅ | ❌ | ➖ |
| Anonymous staff messages | ✅ | ❌ | ❌ |
| Snippets (reusable quick responses) | ✅ | ❌ | ❌ |
| Customizable bot messages (welcome, close, etc.) | ✅ | ✅ | ✅ |
| Keep the thread to the asker & staff only | ❌ | ➖ | ✅ |
| View past tickets button | ✅ | ❌ | ❌ |
| | Modmail | Ticket System | Forum Support |
| ------------------------------------------------- | :-----: | :-----------: | :-----------: |
| Conversation happens directly in a channel/thread | ❌ | ✅ | ✅ |
| Messages relayed via DM | ✅ | ❌ | ➖ |
| Anonymous staff messages | ✅ | ❌ | ❌ |
| Snippets (reusable quick responses) | ✅ | ❌ | ❌ |
| Customizable bot messages (welcome, close, etc.) | ✅ | ✅ | ✅ |
| Keep the thread to the asker & staff only | ❌ | ➖ | ✅ |
| View past tickets button | ✅ | ❌ | ❌ |

## Ticket management

| | Modmail | Ticket System | Forum Support |
| ----------------------------------------- | :---------------: | :-----------: | :-----------: |
| Topics / categories | ✅ | ✅ | ✅ |
| Claiming / assignment | ✅ | ✅ | ✅ |
| Hand a claimed item back to the queue | ➖ | ➖ | ✅ |
| Hold / pause | ✅ | ✅ | ❌ |
| Rename | ✅ | ✅ | ➖ |
| Additional members | ✅ | ✅ | ➖ |
| Scheduled closing | ✅ | ✅ | ❌ |
| Close requests (user/staff confirmation) | ✅ | ✅ | ❌ |
| Close reasons (custom & predefined) | ✅ | ❌ | ❌ |
| One ticket per user limit | ✅ | ✅ | ❌ |
| Per-topic priority | ❌ | ❌ | ✅ |
| Priority by member role | ❌ | ❌ | ✅ |
| Close / "mark solved" button | ✅ | ✅ | ✅ |
| Apply a "solved" tag on close | ➖ | ➖ | ✅ |
| Archive on close | ✅ | ❌ | ✅ |
| Reopen closed items | ✅ | ❌ | ❌ |
| DM confirmation on close | ✅ | ✅ | ✅ |
| Attach transcript to close DM | ✅ | ✅ | ✅ |
| | Modmail | Ticket System | Forum Support |
| ---------------------------------------- | :-----: | :-----------: | :-----------: |
| Topics / categories | ✅ | ✅ | ✅ |
| Claiming / assignment | ✅ | ✅ | ✅ |
| Hand a claimed item back to the queue | ➖ | ➖ | ✅ |
| Hold / pause | ✅ | ✅ | ❌ |
| Rename | ✅ | ✅ | ➖ |
| Additional members | ✅ | ✅ | ➖ |
| Scheduled closing | ✅ | ✅ | ❌ |
| Close requests (user/staff confirmation) | ✅ | ✅ | ❌ |
| Close reasons (custom & predefined) | ✅ | ❌ | ❌ |
| One ticket per user limit | ✅ | ✅ | ❌ |
| Per-topic priority | ❌ | ❌ | ✅ |
| Priority by member role | ❌ | ❌ | ✅ |
| Close / "mark solved" button | ✅ | ✅ | ✅ |
| Apply a "solved" tag on close | ➖ | ➖ | ✅ |
| Archive on close | ✅ | ❌ | ✅ |
| Reopen closed items | ✅ | ❌ | ❌ |
| DM confirmation on close | ✅ | ✅ | ✅ |
| Attach transcript to close DM | ✅ | ✅ | ✅ |

## Automation

| | Modmail | Ticket System | Forum Support |
| ---------------------------------------- | :-----: | :-----------: | :-----------: |
| Auto-close on inactivity | ✅ | ✅ | ✅ |
| Auto-close when user leaves server | ✅ | ✅ | ❌ |
| Inactivity warning before auto-close | ✅ | ✅ | ✅ |
| Team member inactivity reminders | ✅ | ✅ | ✅ |
| Unassigned / unclaimed reminders | ✅ | ✅ | ✅ |
| Only remind inside opening hours | ✅ | ✅ | ✅ |
| Opening hours | ✅ | ✅ | ✅ |
| Closed-hours notice to the member | ✅ | ➖ | ✅ |
| Team notification on new items | ➖ | ✅ | ✅ |
| Built-in AI first answer / deflection | ❌ | ❌ | ✅ |
| Holiday detection & custom holidays | ✅ | ✅ | ✅ |
| | Modmail | Ticket System | Forum Support |
| ------------------------------------- | :-----: | :-----------: | :-----------: |
| Auto-close on inactivity | ✅ | ✅ | ✅ |
| Auto-close when user leaves server | ✅ | ✅ | ❌ |
| Inactivity warning before auto-close | ✅ | ✅ | ✅ |
| Team member inactivity reminders | ✅ | ✅ | ✅ |
| Unassigned / unclaimed reminders | ✅ | ✅ | ✅ |
| Only remind inside opening hours | ✅ | ✅ | ✅ |
| Opening hours | ✅ | ✅ | ✅ |
| Closed-hours notice to the member | ✅ | ➖ | ✅ |
| Team notification on new items | ➖ | ✅ | ✅ |
| Built-in AI first answer / deflection | ❌ | ❌ | ✅ |
| Holiday detection & custom holidays | ✅ | ✅ | ✅ |

## Feedback, analytics & monitoring

Expand Down
8 changes: 4 additions & 4 deletions docs/support-bot/forum-support/ai-deflection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Forum Support can let AI take a first pass at every new thread, answering common

AI auto-answer lives in the **AI** section of the [Configuration](/docs/support-bot/forum-support/configuration#ai) page. The section only appears when AI is available for your server.

| Setting | What it does |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **Enable AI answers** | Posts an AI first response on new threads, with the yes/no buttons. |
| **AI summary on claim**| DMs the claiming staff member a short summary of the conversation so far. |
| Setting | What it does |
| ----------------------- | ------------------------------------------------------------------------- |
| **Enable AI answers** | Posts an AI first response on new threads, with the yes/no buttons. |
| **AI summary on claim** | DMs the claiming staff member a short summary of the conversation so far. |

You can customize the acknowledgement messages for the **Yes** and **No** buttons in the [Messages](/docs/support-bot/forum-support/configuration#messages) section.

Expand Down
Loading
Loading