Files
ajet-chat/docs/prd/README.md
2026-02-17 01:08:02 -05:00

2.2 KiB

ajet-chat PRDs

Product Requirements Documents for ajet-chat v1.

Documents

Module PRD Test Cases Status
shared DB, EventBus, API Client, Schemas, Mentions, Markdown 60 v1
api REST API: 15 endpoint groups, full CRUD 95 v1
auth-gw OAuth, session/token validation, reverse proxy 40 v1
web-sm Browser UI: Datastar SSE, Discord layout 57 v1
tui-sm TUI session manager: SSE JSON events 30 v1
cli CLI commands + Rich TUI (clojure-tui) 50 v1
mobile 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