docs: comprehensive update all docs to v0.0.46
11 files updated to reflect current state (v0.0.22 → v0.0.46): ARCHITECTURE.md: - Ring tones, group calls, read receipts, markdown rendering sections - Bot API expanded (BotFather, numeric IDs, Telegram compat) - Admin commands, known issues, 155 tests TASK_PLAN.md: - All P1-P4 marked DONE with version numbers - Additional completed work section (bots, ETH, ring tones, group calls) - New FC-P7 (Voice & Transport): cpal, Sender Keys, WebTransport - FC-P6-T9/T10 added PROGRESS.md: - Full version history table v0.0.22 through v0.0.46 - Known issues section README.md: - Voice calls, ring tones, group calls, read receipts, markdown, 155 tests SECURITY.md: - Bot API security, voice call security, admin commands sections - Updated protection tables USAGE.md: - Group calls, read receipts, markdown formatting, admin commands CLIENT.md: - Call commands, read receipts, markdown rendering LLM_HELP.md + LLM_BOT_DEV.md: - Call/group call/admin commands, ring tones, per-bot numeric IDs TESTING_E2E.md: - Tests 16-18: ring tones, group calls, admin commands CLAUDE.md: - Ring tone notes, group signal endpoint, MLS roadmap Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# featherChat Usage Guide
|
||||
|
||||
**Version:** 0.0.21
|
||||
**Version:** 0.0.46
|
||||
|
||||
---
|
||||
|
||||
@@ -311,6 +311,63 @@ The web client supports the same slash commands as the TUI: `/peer`, `/p`, `/r`,
|
||||
| `/reject` | Reject incoming call |
|
||||
| `/hangup` | End current call |
|
||||
|
||||
### Group Calls
|
||||
|
||||
Group calls allow multi-party audio within a group context. Any group member can initiate a call, and others can join at any time.
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/gcall` | Start a group call in the current group |
|
||||
| `/gjoin` | Join an active group call |
|
||||
| `/gleave-call` | Leave the group call (call continues for others) |
|
||||
| `/gmute` | Toggle your microphone mute in the group call |
|
||||
|
||||
Group call audio is routed through the WZP QUIC SFU relay. Media is transport-encrypted (QUIC TLS) but not E2E encrypted -- the relay can observe audio streams. MLS-based E2E encryption for group calls is planned.
|
||||
|
||||
---
|
||||
|
||||
## Read Receipts
|
||||
|
||||
featherChat tracks message delivery and read status with three indicators:
|
||||
|
||||
| Indicator | Symbol | Meaning |
|
||||
|-----------|--------|---------|
|
||||
| Sent | Single gray tick | Message sent to server, no confirmation yet |
|
||||
| Delivered | Double gray tick | Recipient decrypted the message |
|
||||
| Read | Double blue tick | Recipient viewed the message in their viewport |
|
||||
|
||||
Read receipts are sent automatically when messages enter the visible area of the chat window. The system uses the sender's fingerprint for tracking and a dedup set to avoid sending duplicate read receipts for the same message.
|
||||
|
||||
---
|
||||
|
||||
## Markdown Formatting
|
||||
|
||||
Messages support markdown formatting in both the TUI and web client:
|
||||
|
||||
| Syntax | Result |
|
||||
|--------|--------|
|
||||
| `**bold**` | **bold** |
|
||||
| `*italic*` | *italic* |
|
||||
| `` `code` `` | `inline code` |
|
||||
| `# Header` | Header (at start of line) |
|
||||
| `> quote` | Block quote (at start of line) |
|
||||
| `- item` | List item (at start of line) |
|
||||
|
||||
Markdown is rendered inline in messages. In the TUI, bold, italic, and code spans use terminal attributes. In the web client, they render as HTML.
|
||||
|
||||
---
|
||||
|
||||
## Admin Commands
|
||||
|
||||
Server administration commands for operators:
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/admin-calls` | List all active calls on the server |
|
||||
| `/admin-unalias <alias>` | Remove any user's alias (requires admin password) |
|
||||
|
||||
`/admin-unalias` prompts for the server's admin password (set via `WARZONE_ADMIN_PASSWORD` environment variable). `/admin-calls` currently has no auth protection -- an admin role system is planned.
|
||||
|
||||
---
|
||||
|
||||
## Groups
|
||||
|
||||
Reference in New Issue
Block a user