docs: replace long dashes, document icons, emoji and avatar rules

Update the status of the client UX defects handled by the interface work.
This commit is contained in:
Loki 2026-10-25 10:26:02 +01:00
parent 220af2d6a4
commit ca3465daa5
Signed by: boba
GPG key ID: 253067914055423B
19 changed files with 311 additions and 303 deletions

View file

@ -1,4 +1,4 @@
# Admin Panel — Design
# Admin Panel - Design
> Target: Phase 1.1 (core) → Phase 1.2 (guilds, roles) → Phase 2 (plugins, bot permissions)
@ -6,11 +6,11 @@
| Layer | Config file (TOML) | Admin panel (GUI) |
|-------|-------------------|-------------------|
| **Infrastructure** | `bind`, `ports`, `data_dir`, TLS certs | — |
| **Infrastructure** | `bind`, `ports`, `data_dir`, TLS certs | - |
| **Node identity** | `name`, `address` | Display only |
| **Storage** | `backend`, `sqlite_path`, `retention` | — |
| **Storage** | `backend`, `sqlite_path`, `retention` | - |
| **Security** | federation gate, rate limits, session timeout | Ban list, mute, kick |
| **Runtime state** | — | Channels, roles, members, invites, audit log |
| **Runtime state** | - | Channels, roles, members, invites, audit log |
| **Plugins** | Plugin enable/disable | Permission keys, commands |
**Rule of thumb:** If it needs a server restart → TOML. If it can apply live → GUI.
@ -24,22 +24,22 @@ Designed for both built-in actions and plugin/bot commands (inspired by LuckPerm
### Built-in permission keys
```
vnox.admin.manage_channels — create, edit, delete channels
vnox.admin.manage_roles — create, edit, delete roles
vnox.admin.manage_members — kick, ban, mute, timeout
vnox.admin.manage_invites — create, delete invites
vnox.admin.manage_guild — edit guild name, icon, settings
vnox.admin.view_audit_log — read audit log
vnox.admin.manage_channels - create, edit, delete channels
vnox.admin.manage_roles - create, edit, delete roles
vnox.admin.manage_members - kick, ban, mute, timeout
vnox.admin.manage_invites - create, delete invites
vnox.admin.manage_guild - edit guild name, icon, settings
vnox.admin.view_audit_log - read audit log
vnox.channel.read — view channel
vnox.channel.send — send messages
vnox.channel.voice_connect — join voice channel
vnox.channel.voice_speak — speak in voice (push-to-talk)
vnox.channel.voice_mute_members — server-mute others
vnox.channel.read - view channel
vnox.channel.send - send messages
vnox.channel.voice_connect - join voice channel
vnox.channel.voice_speak - speak in voice (push-to-talk)
vnox.channel.voice_mute_members - server-mute others
vnox.dm.send — send direct messages
vnox.friend.request — send friend requests
vnox.presence.view — see online status
vnox.dm.send - send direct messages
vnox.friend.request - send friend requests
vnox.presence.view - see online status
```
### Custom permission keys (plugin/bot commands)
@ -47,24 +47,24 @@ vnox.presence.view — see online status
Plugins register their permissions at load time via the RPC API:
```
mybot.command.greet — /greet command
mybot.command.play — /play music
mybot.command.ban_override — override sub-command
mybot.command.greet - /greet command
mybot.command.play - /play music
mybot.command.ban_override - override sub-command
```
**Wildcard support:**
```
vnox.admin.* — all admin permissions
vnox.channel.* — all channel permissions
mybot.* — all commands from mybot
* — everything (owner only)
vnox.admin.* - all admin permissions
vnox.channel.* - all channel permissions
mybot.* - all commands from mybot
* - everything (owner only)
```
### How it works
```
┌──────────────────────────────────────────────────┐
│ Role Editor — "Moderator" │
│ Role Editor - "Moderator" │
├──────────────────────────────────────────────────┤
│ Permission keys: │
│ │
@ -91,14 +91,14 @@ mybot.* — all commands from mybot
```
**Resolution order (highest priority wins):**
1. Owner — overrides everything
2. Channel override (user-specific) — allow/deny
3. Channel override (role-specific) — allow/deny
1. Owner - overrides everything
2. Channel override (user-specific) - allow/deny
3. Channel override (role-specific) - allow/deny
4. Role hierarchy (top role has higher priority)
5. @everyone default
6. Server-wide default
Each override is `(allow_mask, deny_mask)` — deny always beats allow at the same level.
Each override is `(allow_mask, deny_mask)` - deny always beats allow at the same level.
### Database
@ -184,10 +184,10 @@ Server Settings → Channels → [+ Add]
Double-click channel or right-click → "Edit Channel".
Same modal pre-filled, plus:
- **Name change** — updates slug
- **Category change** — moves channel
- **Drag position** — reorder inside category
- **Delete** — with confirmation (soft delete in DB)
- **Name change** - updates slug
- **Category change** - moves channel
- **Drag position** - reorder inside category
- **Delete** - with confirmation (soft delete in DB)
### Drag & Drop
@ -363,7 +363,7 @@ PID 0x00A2 GUILD_TRANSFER client → gateway (owner only)
}
```
**ADMIN_UPDATE_CHANNEL (0x0072) — includes position changes via drag & drop:**
**ADMIN_UPDATE_CHANNEL (0x0072) - includes position changes via drag & drop:**
```json
{
"channel_id": "uuid",
@ -390,7 +390,7 @@ Gateway checks:
2. Is user in guild? → 403 if no
3. Does user have vnox.admin.manage_channels?
- Resolve role hierarchy
- Check channel_overrides (none — new channel)
- Check channel_overrides (none - new channel)
- Check wildcards (vnox.admin.*)
- Owner override → 403 if no
│