Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ export default defineConfig({
text: "Inviting the Bot",
link: "/setup/invite",
},
{
text: "Setup Wizard",
link: "/setup/onboarding",
},
{
text: "Language Customisation",
link: "/setup/language-customisation",
Expand Down
8 changes: 7 additions & 1 deletion docs/src/en/setup/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bot Configuration: Web Dashboard

The web dashboard is where you configure Tickets for your Discord server. This page walks you through logging in and selecting your server, then points you to the full dashboard guide.
The web dashboard is where you configure Tickets for your Discord server. This page walks you through logging in and selecting your server, then points you to the setup wizard and the full dashboard guide.

## Logging In

Expand All @@ -19,6 +19,12 @@ If your server does not appear, check the following:

![Servers](../../img/dashboard/introduction/servers.webp)

## First-Time Setup

If this is the first time you are configuring Tickets for a server, a setup banner will appear inviting you to the **Setup Wizard**. The wizard guides you through creating teams, forms, and your first ticket panel in a few minutes.

See [Setup Wizard](./onboarding) for a full walkthrough.

## Exploring the Dashboard

For a complete tour of the dashboard layout, sidebar navigation, keyboard shortcuts, and command palette, see the [Dashboard Introduction](/dashboard/introduction).
138 changes: 138 additions & 0 deletions docs/src/en/setup/onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# Setup Wizard

When you first add Tickets to your server and open the web dashboard, you'll be guided through a setup wizard that walks you through configuring the essentials. The wizard covers creating support teams, building ticket forms, setting up panels, and adjusting basic settings, everything you need to get a working ticket system up and running.

::: info
The setup wizard is only shown to server administrators (permission level 2+). Support staff will not see it.
:::

## Accessing the Wizard

The wizard appears automatically the first time an administrator opens the web dashboard for a newly invited server. A blue banner at the top of the web dashboard links to the wizard.

![Onboarding banner](../../img/onboarding_banner.webp)

If you dismiss or skip the wizard, you can always return to it manually by navigating to:

```text
https://dashboard.tickets.bot/manage/<your-server-id>/setup
```

## Step 1: Welcome

The welcome screen introduces the wizard and shows an overview of the steps ahead. Your server's name and icon are displayed at the top.

![Onboarding welcome](../../img/onboarding_welcome.webp)

- **Let's get started** - begins the guided setup.
- **Skip setup** - dismisses the wizard and takes you to the settings page. You can return to the wizard later if needed.

## Step 2: Teams

Support teams determine which staff members receive and handle tickets. In this step you can create one or more teams and assign Discord roles to them.

![Onboarding teams](../../img/onboarding_teams.webp)

1. Enter a **team name** (e.g. "Support", "Billing", "Moderators") and click **Create Team**.
2. Once created, use the **role selector** to assign Discord roles to the team. Members with those roles will be able to see and respond to tickets routed to this team.
3. You can create multiple teams, each can handle different types of tickets.

::: tip
You can always create more teams or adjust role assignments later from the [Staff Teams](/dashboard/staff-teams) page.
:::

If you skip this step, a default team will be used, which includes all users with the Administrator permission.

## Step 3: Forms

Forms collect information from users when they open a ticket. For example, you might ask for their issue description, order number, or preferred language before the ticket is created.

![Onboarding forms](../../img/onboarding_forms.webp)

1. Enter a **form title** (e.g. "Support Request") and click **Create**.
2. Click **+ Add Field** to add questions to the form.
3. For each field, configure:
- **Label** - the question text shown to the user.
- **Type** - Text Input, String Select, User Select, Role Select, Mentionable Select, Channel Select, Radio Group, or Checkbox Group.
- **Style** - for text inputs, choose between single-line or multi-line.
- **Required** - whether the user must fill in this field.
- **Length/Items Range** - minimum and maximum character count (for text) or selection count (for selects).
- **Options** - for select, radio, and checkbox types, add the choices the user can pick from.

You can add up to **5 fields** per form. Forms are saved automatically when you advance to the next step.

::: info
Forms are optional. If you skip this step, users will open tickets without being asked any questions. You can always create forms later from the [Forms](/dashboard/forms) page.
:::

## Step 4: Panels

A panel is the embed message with a button that users click to open a ticket. This is the most visible part of your ticket system, it is what your members will interact with.

You have two options:

### Import a Template

The **Import a template** tab shows featured panel templates from the community gallery. These are pre-configured panels that you can import with a couple of clicks.

![Onboarding panels import](../../img/onboarding_panels_import.webp)

1. Browse the featured templates and click **Import** on one you like.
2. Select a **channel** to send the panel message to (this should be a channel all members can see).
3. Select a **category** for ticket channels to be created under.
4. Click **Import Panel**, the panel will be created and sent to your Discord server immediately.

### Create from Scratch

The **Create from scratch** tab lets you build a panel yourself:

![Onboarding panels create](../../img/onboarding_panels_create.webp)

- **Title** - the bold heading of the panel embed.
- **Content** - the description text in the embed.
- **Colour** - the accent colour on the left side of the embed.
- **Channel** - where the panel message will be sent.
- **Category** - where ticket channels will be created.
- **Team** - which support team handles tickets from this panel.
- **Form** - optionally attach a form you created in the previous step.

Click **Create Panel** to send the panel to Discord.

::: tip
You can create additional panels later from the [Ticket Panels](/dashboard/ticket-panels) page, including advanced options like welcome messages, access control lists, cooldowns, and support hours.
:::

## Step 5: Settings

The final step lets you adjust a few common settings. These are a small subset of the full settings available on the [Settings](/dashboard/settings/settings) page.

![Onboarding settings](../../img/onboarding_settings.webp)

- **Language** - the language used for bot messages in Discord.
- **Success / Failure colour** - the accent colours used in bot embeds for success and error messages.
- **Users can close their own tickets** - whether ticket openers can close their own tickets.
- **Close confirmation** - whether a confirmation prompt is shown before closing a ticket.
- **Feedback enabled** - whether users are asked to rate their support experience after a ticket is closed.

Click **Finish Setup** to save your settings and complete the wizard.

## Completion

After finishing the wizard, you will see a summary of what was created (teams, forms, and panels) along with links to the most useful dashboard pages.

![Onboarding done](../../img/onboarding_done.webp)

From here you can:

- **View your panels** - see and manage all your ticket panels.
- **Manage your teams** - adjust team members and permissions.
- **Explore the gallery** - find more panel templates to import.
- **Advanced settings** - configure auto-close, claiming, thread mode, and more.

## Resuming the Wizard

If you close the wizard partway through, your progress is saved. When you return, the wizard will pick up where you left off. Any teams, forms, or panels you created during the wizard are saved immediately, you will not lose them.

## Dismissing the Banner

The setup banner on the web dashboard can be dismissed by clicking **Dismiss**. Once dismissed, it will not appear again for that server. You can still access the wizard directly via the URL if you change your mind.
2 changes: 1 addition & 1 deletion docs/src/en/setup/ticket-panels.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ At a minimum, configure these four fields to get a working panel:
4. **Support Team** - which staff team will handle tickets opened from this panel

:::tip Create a Support Team First
If you have not created a support team yet, visit the [Staff Teams](/dashboard/staff-teams) page first.
If you have not created a support team yet, visit the [Staff Teams](/dashboard/staff-teams) page first, or use the [Setup Wizard](./onboarding) which guides you through teams, forms, and panels in order.
:::

### Optional Fields
Expand Down
Binary file added docs/src/img/onboarding_banner.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_done.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_forms.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_panels_create.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_panels_import.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_settings.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_teams.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/img/onboarding_welcome.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading