Document contracts and shared package responsibilities

- Clarify that `packages/contracts` is schema-only with no runtime logic - Add `packages/shared` as the home for shared runtime utilities and subpath exports

Julius Marminge committed 8 months ago

Commit c2aaa891 parent dde48e91 file · +2 −1Browse files

Unified · Split

AGENTS.md+2−1

@@ -26,7 +26,8 @@ Long term maintainability is a core priority. If you add new functionality, firs · 25 unmodified lines
26	26
27	27	- `apps/server`: Node.js WebSocket server. Wraps Codex app-server (JSON-RPC over stdio), serves the React web app, and manages provider sessions.
28	28	- `apps/web`: React/Vite UI. Owns session UX, conversation/event rendering, and client-side state. Connects to the server via WebSocket.
29		−- `packages/contracts`: Shared effect/Schema schemas and TypeScript contracts for provider events, WebSocket protocol, and model/session types.
	29	+- `packages/contracts`: Shared effect/Schema schemas and TypeScript contracts for provider events, WebSocket protocol, and model/session types. Keep this package schema-only — no runtime logic.
	30	+- `packages/shared`: Shared runtime utilities consumed by both server and web. Uses explicit subpath exports (e.g. `@t3tools/shared/git`) — no barrel index.
30	31
31	32	## Codex App Server (Important)
32	33