The codebase has very little inline documentation and the docs in docs/ are partially stale (see #27).
Priorities:
- document the non-obvious modules:
server/src/lib/dbPersistence.ts (Yjs persistence via @hocuspocus/extension-database), server/src/sockets/ws-server.ts, server/src/lib/shareToken.ts, and the auth flow (JWT access/refresh, httpOnly cookies, rotation)
- document the client layering convention enforced by ESLint (app -> features -> shared,
import/no-restricted-paths)
- document the env var contract for both packages (server zod validation in
server/src/config/env.config.ts, client client/src/config/env.ts)
The codebase has very little inline documentation and the docs in
docs/are partially stale (see #27).Priorities:
server/src/lib/dbPersistence.ts(Yjs persistence via @hocuspocus/extension-database),server/src/sockets/ws-server.ts,server/src/lib/shareToken.ts, and the auth flow (JWT access/refresh, httpOnly cookies, rotation)import/no-restricted-paths)server/src/config/env.config.ts, clientclient/src/config/env.ts)