Component Documentation
Per-module documentation for the modules that have landed. One page per
significant src/ module: responsibility, public surface, dependencies, and
any non-obvious behavior.
Landed (Phase 1)
| Module | Page |
|---|---|
src/config.ts | config |
src/lib/log.ts | lib-log |
src/http/server.ts | http-server |
src/http/healthz.ts | http-healthz |
src/http/telegramWebhook.ts | http-telegramWebhook |
src/telegram/normalize.ts | telegram-normalize |
src/telegram/client.ts | telegram-client |
src/telegram/echo.ts | telegram-echo |
src/telegram/dispatch.ts | telegram-dispatch |
src/db/client.ts | db-client |
src/db/users.ts | db-users |
Planned (later phases)
Sketched in ../plan/design-overview.md under “Repo Layout”:
src/telegram/outbound.ts—send_message/send_image/edit_message/send_buttonsimplementations (Phase 2)src/mcp/— server, auth, sessions, notifications, tools (Phase 2–6)src/auth/— user status/role checks, middleware (Phase 3)src/memory/— KV + chat history store (Phase 4)src/jobs/— Inngest events, client, functions (Phase 5)src/lib/errors.ts— JSON-RPC error code mapping (Phase 2)
See ../plan/ for what’s being built when.