docs(agents): rewrite package map and conventions for Veect
AGENTS.md now describes the Veect control plane (ADR-027/028/029,
docs/product/ authority table, glossary Veect-domain vocabulary), with
the package map, boundary tags, and per-package conventions verified
against the filesystem (auth + 11 core + 3 tooling packages;
web-next/cms/storybook apps) and code examples drawn from the real auth
feature. Adds warning notes for known generator staleness — the
release-please per-feature registration that would collide with the
root-only v* tag policy, the pre-shipped trace overwrite hazard (zod
incident, restored in e4a3b65), the trpc template's removed
@trpc/react-query dep — and records the accepted warn-severity lint
backlog (~93 findings).
Per story amendments, the same slice prunes the dead "web-tanstack"
member from core-shared's app-tag unions (bind-otel-instrumentation.ts,
sentry/init-client.ts; tests retargeted to "web-next") and fixes the
stale app/feature tag lists in docs/architecture/overview.md. A warning
comment mirrors the release-please note at the generator call site; no
functional generator changes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016j8z4VHjedXDTjEDNg7qHK
This commit is contained in:
@@ -13,8 +13,8 @@ packages/
|
||||
core-cms/ Composition only: assembles feature CMS exports into one Payload config
|
||||
core-api/ Composition only: aggregates feature tRPC routers into one appRouter
|
||||
|
||||
# Optional cross-cutting cores (scaffold on demand via `pnpm turbo gen core-package <name>`)
|
||||
core-trpc/ Frontend tRPC client + per-framework providers (Next.js, TanStack)
|
||||
# Optional cross-cutting cores (all currently scaffolded; new ones via `pnpm turbo gen core-package <name>`)
|
||||
core-trpc/ Frontend tRPC client + Next.js provider
|
||||
core-ui/ Design-system primitives (atoms, molecules, generic organisms, templates)
|
||||
core-realtime/ Socket.IO server + broadcaster + handler registry (ADR-016)
|
||||
core-events/ In-memory + Payload-backed event bus + job queue (ADR-015)
|
||||
@@ -25,10 +25,9 @@ packages/
|
||||
|
||||
# Business capabilities
|
||||
auth/ Users + sign-in/sign-up/sign-out + session/cookie domain
|
||||
blog/ Articles collection + publishing flow
|
||||
media/ Media upload collection (skeleton; expand with optimization, CDN, etc.)
|
||||
marketing-pages/ Pages collection + SiteSettings global
|
||||
navigation/ Header global + menu items
|
||||
(control-plane identity, ADR-027; the Veect features —
|
||||
workspaces, projects, discovery, design-doc, editor —
|
||||
land as sibling feature packages)
|
||||
|
||||
# Tooling
|
||||
core-eslint/ Shared ESLint flat config + conformance rules + boundary rules
|
||||
@@ -42,7 +41,7 @@ See `docs/architecture/template-tiers.md` for the must-have/optional split and t
|
||||
|
||||
```
|
||||
React component
|
||||
↓ useQuery(trpc.blog.articleBySlug.queryOptions({slug})) ← @repo/<feature>/ui (queries)
|
||||
↓ useQuery(trpc.<feature>.<procedure>.queryOptions({...})) ← @repo/<feature>/ui (queries)
|
||||
HTTP /api/trpc
|
||||
↓
|
||||
tRPC procedure (xProcedure.input(xInputSchema)) ← integrations/api/router.ts
|
||||
@@ -106,10 +105,10 @@ Both use the same five-tag model; see "Five tags" section below.
|
||||
|
||||
The workspace is organized into five mutually exclusive tags:
|
||||
|
||||
- **app** (4 packages): `apps/cms`, `apps/web-next`, `apps/web-tanstack`, `apps/storybook`
|
||||
- **core-composition** (2 must-have): `packages/core-api`, `packages/core-cms`. Plus `packages/core-trpc` when scaffolded via `pnpm turbo gen core-package trpc` (optional).
|
||||
- **core** (1 must-have): `packages/core-shared`. Plus `core-ui`, `core-realtime`, `core-events`, `core-audit`, `core-analytics`, `core-consent`, `core-dsr` when scaffolded via `pnpm turbo gen core-package <name>` (optional).
|
||||
- **feature** (5 packages): `packages/auth`, `packages/blog`, `packages/media`, `packages/marketing-pages`, `packages/navigation`
|
||||
- **app** (3 packages): `apps/cms`, `apps/web-next`, `apps/storybook`
|
||||
- **core-composition** (3 packages): `packages/core-api`, `packages/core-cms` (must-have). Plus `packages/core-trpc` (optional, currently scaffolded).
|
||||
- **core** (8 packages): `packages/core-shared` (must-have). Plus the optional cores `core-ui`, `core-realtime`, `core-events`, `core-audit`, `core-analytics`, `core-consent`, `core-dsr` (all currently scaffolded; new ones via `pnpm turbo gen core-package <name>`).
|
||||
- **feature** (1 package): `packages/auth`
|
||||
- **tooling** (3 packages): `packages/core-eslint`, `packages/core-typescript`, `packages/core-testing`
|
||||
|
||||
See `docs/architecture/template-tiers.md` for the must-have/optional split and the scaffold commands.
|
||||
|
||||
Reference in New Issue
Block a user