docs: refresh README, FUTURE, and API docs for shipped features (LC-145) #173

Merged

nrupard merged 1 commit from chore/lc-145-update-docs into main

2026-05-21 21:26:13 +02:00

nrupard commented

2026-05-21 21:25:11 +02:00

Owner

What

Documentation refresh (LC-145): bring README, FUTURE.md, and docs/api.md back in line with everything merged since the last doc pass.

Changes

README Features rewritten and grouped (Messaging / Voice and video / Spaces / Notifications / Integrations / Administration) to cover shipped features that were undocumented: 1:1 audio+video calls with mic/camera/speaker selection, enclave voice channels, enclaves, polls, reminders, slash commands, pinned messages, bookmarks, branding (logo/colors/favicon), PWA + offline outbox, analytics dashboard, backup/restore, anti-spam, incoming + outgoing webhooks, scoped API tokens, bot identities, 2FA, and web push.
README env var table gains LETS_CHAT_ICE_SERVERS, LETS_CHAT_PUSH_CONTACT, LETS_CHAT_SERVER_URL, and LETS_CHAT_UPDATE_URL. Defaults verified against server/src/main.rs and the desktop config reads, not copied blind.
FUTURE.md: all seven originally-deferred items (private rooms, uploads, editing, reactions, typing, read receipts, search) have shipped. The file now records them as done and points at the YouTrack LC-* roadmap rather than pretending they are pending.
docs/api.md: added a Bots section (LC-73). Verified against routes/admin.rs: bots are created at Admin -> Bots, mint an API token on creation (requires LETS_CHAT_SECRET_KEY + at least one scope), and authenticate via the same bearer + scope model as user tokens.

Notes

Docs-only change: no Rust, templates, CSS, or JS touched, so no rebuild or test run is required.

🤖 Generated with Claude Code

## What Documentation refresh (LC-145): bring README, FUTURE.md, and docs/api.md back in line with everything merged since the last doc pass. ## Changes - **README Features** rewritten and grouped (Messaging / Voice and video / Spaces / Notifications / Integrations / Administration) to cover shipped features that were undocumented: 1:1 audio+video calls with mic/camera/speaker selection, enclave voice channels, enclaves, polls, reminders, slash commands, pinned messages, bookmarks, branding (logo/colors/favicon), PWA + offline outbox, analytics dashboard, backup/restore, anti-spam, incoming + outgoing webhooks, scoped API tokens, bot identities, 2FA, and web push. - **README env var table** gains `LETS_CHAT_ICE_SERVERS`, `LETS_CHAT_PUSH_CONTACT`, `LETS_CHAT_SERVER_URL`, and `LETS_CHAT_UPDATE_URL`. Defaults verified against `server/src/main.rs` and the desktop config reads, not copied blind. - **FUTURE.md**: all seven originally-deferred items (private rooms, uploads, editing, reactions, typing, read receipts, search) have shipped. The file now records them as done and points at the YouTrack LC-* roadmap rather than pretending they are pending. - **docs/api.md**: added a Bots section (LC-73). Verified against `routes/admin.rs`: bots are created at Admin -> Bots, mint an API token on creation (requires `LETS_CHAT_SECRET_KEY` + at least one scope), and authenticate via the same bearer + scope model as user tokens. ## Notes Docs-only change: no Rust, templates, CSS, or JS touched, so no rebuild or test run is required. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

nrupard added 1 commit

2026-05-21 21:25:11 +02:00

docs: refresh README, FUTURE, and API docs for shipped features (LC-145)

Create release / Create release from merged PR (pull_request) Has been skipped

Details

Check / clippy + fmt + tests (pull_request) Successful in 1m30s

Details

7f47cc56f9

README Features list rewritten and grouped (messaging, voice/video, spaces, notifications, integrations, administration) to cover everything merged since the last doc pass: 1:1 calls + device select, enclave voice channels, enclaves, polls, reminders, slash commands, pinned messages, bookmarks, branding, PWA/offline outbox, analytics, backup/restore, anti-spam, incoming/outgoing webhooks, API tokens, bots, 2FA, and web push.

README env var table gains LETS_CHAT_ICE_SERVERS, LETS_CHAT_PUSH_CONTACT, LETS_CHAT_SERVER_URL, and LETS_CHAT_UPDATE_URL (values verified against server/src/main.rs and desktop config reads).

FUTURE.md rewritten: every originally-deferred item (private rooms, uploads, editing, reactions, typing, read receipts, search) has shipped, so the file now marks them done and points at the YouTrack roadmap.

docs/api.md gains a Bots section: bot accounts are created at Admin -> Bots, mint an API token on creation, and authenticate via the same bearer + scope model as user tokens.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>