init prds

2026-02-17 01:08:02 -05:00
parent 79b6a5e225
commit a3b28549b4
8 changed files with 2329 additions and 0 deletions
@@ -0,0 +1,38 @@
+# ajet-chat PRDs
+
+Product Requirements Documents for ajet-chat v1.
+
+## Documents
+
+| Module | PRD | Test Cases | Status |
+|--------|-----|------------|--------|
+| [shared](shared.md) | DB, EventBus, API Client, Schemas, Mentions, Markdown | 60 | v1 |
+| [api](api.md) | REST API: 15 endpoint groups, full CRUD | 95 | v1 |
+| [auth-gw](auth-gw.md) | OAuth, session/token validation, reverse proxy | 40 | v1 |
+| [web-sm](web-sm.md) | Browser UI: Datastar SSE, Discord layout | 57 | v1 |
+| [tui-sm](tui-sm.md) | TUI session manager: SSE JSON events | 30 | v1 |
+| [cli](cli.md) | CLI commands + Rich TUI (clojure-tui) | 50 | v1 |
+| [mobile](mobile.md) | Deferred — PWA recommended for v1 | 0 | v2+ |
+
+**Total test cases: ~332**
+
+## Key Product Decisions
+
+- **Multi-community** — users can be in multiple communities (Discord model)
+- **Discord-style layout** — community icon strip, categories, channel sidebar
+- **DMs are global** — separate from communities, always accessible
+- **Flat threads** — Slack-style 1-level threads, no nesting
+- **Discord-flavor markdown** — bold, italic, strikethrough, underline, spoilers, code blocks
+- **Mention storage** — `@<user:uuid>` / `@<here>` / `#<channel:uuid>` in DB, rendered at display time
+- **1-hour edit window** — messages can only be edited within 1 hour of creation
+- **Images + paste** — clipboard paste and upload, no arbitrary file types in v1
+- **OAuth-only auth** — GitHub + Gitea + generic OIDC (for self-hosters)
+- **3-tier roles** — Owner / Admin / Member (no custom roles in v1)
+- **Invite links + direct invites** — admins generate links or invite by user ID
+- **Incoming webhooks** — external services POST to channel (outgoing deferred)
+- **Full slash commands** — /help, /kick, /ban, /mute, /topic, /nick, /token, /webhook, /status
+- **Global search** — messages + channels + users via PostgreSQL tsvector
+- **Full Datastar hypermedia** — server-rendered HTML, SSE fragment updates, minimal client JS
+- **Paginated messages** — "Load older" button, cursor-based pagination
+- **Rich TUI** — split panes, inline images (timg/sixel), markdown rendering, mouse support
+- **Full CLI** — all operations scriptable, JSON output, stdin piping