Repository map (agents)
Use this table to find the source of truth for a topic. Do not invent parallel docs in package READMEs.
Top-level directories
| Directory | Purpose | Read first |
|---|---|---|
docs/ |
Canonical human + agent documentation | docs catalog · architecture diagrams · contributing sync |
docs/templates/ |
Portable templates for other agents/repos | nuxt-ssr-cicd · commit-pr-rules |
.agents/skills/ |
Repo Agent Skills (operate + portable templates) | portfolio-aws-cicd · nuxt-ssr-cicd-template |
core/web/ |
Nuxt 4 app @tgmc/web |
web/README.md (public chrome IA), august launch, nuxt.config.ts |
core/admin/ |
Docker-only admin @tgmc/admin |
admin.md, core/admin/README.md |
core/web-e2e/ |
Cypress E2E | cypress.config.ts |
packages/utilities/ |
Shared Node + /browser + /universal |
packages/utilities.md |
packages/media/ |
DAM catalog SDK (SQLite/FS) | packages/media.md · Postgres stores packages/media-postgres/: packages/media-postgres.md |
packages/media-aws/ |
DynamoDB/S3/SQS adapters + worker | packages/media-aws.md |
packages/media-client/ |
Portable media HTTP client | packages/media-client.md |
packages/media-nuxt/ |
Nuxt module mounting /api/media/* |
packages/media-nuxt.md |
packages/media-player/ |
Media player lib | packages/media-player/README.md · packages hub |
packages/likwidlibs/ |
Shared libs / generators | packages/likwidlibs/README.md · packages hub |
packages/nuxt-layer-base/ |
Base Nuxt layer (theme stylesheet, Sass, a11y, icons, overlay + motion helpers) | packages/nuxt-layer-base.md |
packages/nuxt-layer-ui/ |
UI Nuxt layer (PrimeVue, Ui* kit, useUiStack, useAppToast); extends base |
packages/nuxt-layer-ui.md |
theme/core/ |
@tgmc/theme tokens + page-fit / ratios (via dist) |
packages/theme.md · Sass theme-* in scss/tokens/_color-fns.scss · rebuild with npm run build --workspace=@tgmc/theme |
archive/v1/ |
Playful home/gallery snapshot (not imported) | archive/v1/README.md |
archive/v2/ |
Pre-ember coral/ivory launch snapshot (not imported) | archive/v2/README.md |
archive/v3/ |
Credential-plaza home snapshot (not imported) | archive/v3/README.md |
docker/ |
Compose + Dockerfiles | docker.md |
infra/sam/ |
SAM template, samconfig, staged .aws-sam/ |
infra.md, shared CDN handoff |
scripts/ |
migrate, SAM, GH env, lint-staged, update-agents | this map + script headers |
.github/workflows/ |
CI/CD YAML | cicd.md |
.husky/ |
Git hooks | dev/git-hooks.md |
data/ |
Local SQLite (gitignored) | web/setup/environment.md |
Important files
| File | Role |
|---|---|
package.json |
Workspaces, scripts, keywords, engines.node >= 24 |
docs/dev/github-access.md |
Intended GitHub About, topics, homepage, gh repo edit |
nx.json |
Nx plugins and target defaults |
tsconfig.json |
Project references |
vitest.workspace.ts |
Vitest globs |
.nvmrc |
Node 24 |
core/web/nuxt.config.ts |
Aliases, Nitro preset, runtimeConfig, CDN |
core/web/shared/preferences/ |
Preferences: setups, storage, FOUC — personalization.md |
core/web/content.config.ts |
@nuxt/content + SQLite connector |
../../core/web/app/components/AppPrimaryNav/index.vue |
Primary rail (inline ≥768 px; items in shared/primary-nav.ts): About / Work / Gallery / Code / Writing |
core/web/shared/contrast-guard.ts |
Style Studio role-on-page check (evaluateRoleContrast, 3:1) |
core/web/shared/browse-query.ts + app/composables/useBrowseQuery.ts |
Gallery menu / Docs toolbar state ↔ URL query (useBrowseQuery wraps the ui layer’s useRouteQueryState) |
core/web/app/components/gallery/ + app/layouts/gallery.vue |
/gallery: full-bleed layout, GalleryMenu, justified GalleryGrid, GalleryViewer feed (?item=) — gallery-and-docs.md |
packages/nuxt-layer-ui/app/crud/ |
Pure list / delete / URL-state code (confirm + Undo, paging, CrudAdapter); export ./crud |
core/web/app/components/AppStoryPager.vue |
End-of-case-study previous / next + Get in touch |
core/admin/app/utils/media-presets.ts |
Admin media variant presets, kind counts |
core/web/app/components/AppWorkSubNav.vue |
Work Related: Docs / AI Lab / Process |
docs/portfolio-august-launch.md |
Public IA, restyle layouts, teal spots, launch QA |
infra/sam/template.yaml |
Lambda, HTTP API, DynamoDB, S3, CloudFront |
docker/docker-compose.local.yml |
SQLite ./data + web :4200 (exclusive with docker:dev) |
docker/docker-compose.dev.yml |
api :4100 + web :4200 + shared DynamoDB Local / MinIO (Postgres opt-in) |
docker/docker-compose.test.yml |
DynamoDB Local + Lambda RIE + proxy :4300 |
docker/docker-compose.admin.yml |
Standalone admin: all DBs + MinIO + @tgmc/admin :4400 |
lint-staged.config.mjs |
Pre-commit Prettier + Nx ESLint |
Doc vs code README
| Location | Length | Role |
|---|---|---|
README.md (root) |
Short | GitHub + Pages entry: badges, quick start, links |
docs/** |
Full | Runbooks, matrices, agent instructions |
docker/README.md, infra/sam/README.md |
Operational | Commands that must sit next to Compose/SAM files; mirrored from docs/docker.md / docs/infra.md |
Package README.md |
Package-local | Install/API for that package only |