Skip to content

Commit a80aeca

Browse files
committed
docs(ticketbot): document the dashboard language switcher
1 parent 1c58a26 commit a80aeca

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

discord/discord_ticketbot/dashboard.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,37 @@ nothing about your bot changes.
2323
| **Bot control** | Start, stop, restart and update the bot, plus a live console. |
2424
| **Permissions** | Decide which roles and users may use the dashboard, and what they may do. |
2525
| **Dashboard settings** | Set the [accent colour and favicon](#dashboard-settings) to brand the dashboard. Gated by its own view / edit permissions (the owner always has both). |
26+
| **Language** | Each user picks [their own interface language](#language) from seven translations. |
2627

2728
Every view has its own URL (`/tickets`, `/stats`, `/permissions`, an open ticket
2829
is `/tickets/123`), so a reload keeps you on the same page and links are
2930
shareable.
3031

32+
## Language
33+
34+
The dashboard is available in **English, German, French, Spanish, Portuguese,
35+
Polish and Hungarian**. The selector sits at the bottom of the sidebar, above
36+
"Sign out".
37+
38+
Each person picks their own language: the choice is stored in their browser, so
39+
switching the panel to German changes nothing for anyone else, and it needs no
40+
permission. On a first visit the dashboard follows the browser's language and
41+
falls back to English. Dates and times follow the selected language too.
42+
43+
:::note
44+
This is the **dashboard's** interface language. It is separate from `lang` in
45+
`config.jsonc`, which controls what the **bot** writes into Discord. One staff
46+
member reading the panel in Polish does not change what your ticket embeds say.
47+
:::
48+
49+
Adding a language needs no code change: drop a `web/src/locales/<code>.json`
50+
(copy `en.json`, translate the values, set `$meta.name` to the language's own
51+
name) and rebuild the frontend. It appears in the selector on its own. Any key you
52+
leave out falls back to English rather than breaking the page.
53+
54+
The structured `config.jsonc` form (its field labels and help texts) is still
55+
English only; the rest of the dashboard is translated.
56+
3157
## Quick start
3258

3359
```bash

0 commit comments

Comments
 (0)