tgmc-portfolio documentation

Canonical instructions for this monorepo live under docs/. The root README is a GitHub landing page only.

Agents: start at Agent guide. Humans: Quick start.

Catalog (by directory)

Instructions are grouped the same way as the repo. Prefer these pages over duplicating setup in package READMEs.

On GitHub Pages, use the topic links (themed HTML). Filenames in the GitHub tree catalog: docs/README.md.

Topic	Path
CI/CD	`cicd.md`
Docker	`docker.md` (local/dev/test + admin stack)
SAM / AWS	`infra.md`
Contributing	`contributing.md`
August launch	`portfolio-august-launch.md` (public IA + restyle)
Nuxt SSR CI/CD template	`templates/nuxt-ssr-cicd/`
Commit / PR rules template	`templates/commit-pr-rules/`

Topic	Path
Agent guide	`agents/README.md`
Repo map	`agents/map.md`
Shared CDN handoff	`agents/shared-cdn-handoff.md` (archived; see infra.md)

Root AGENTS.md is a generated checklist. Edit scripts/update-agents.mjs or pages here; do not hand-edit AGENTS.md.

Topic	Path
App docs hub	`web/README.md`
Quick start	`web/guides/quickstart.md`
Examples	`web/guides/examples.md`
Environment variables	`web/setup/environment.md`
SSL / HTTPS	`web/setup/ssl-setup.md`
CDN guide	`web/features/cdn-guide.md`
CDN quick start	`web/features/cdn-quickstart.md`
Messages API	`web/features/messages-api.md`
Docker-only admin	`web/features/admin.md`
Page data loading	`web/features/page-data-loading.md`
Gallery and docs hubs	`web/features/gallery-and-docs.md` (`/docs` via Work sub-nav)
Data stores	`web/data-stores.md`
Project structure	`web/reference/project-structure.md`
Architecture hub	`web/reference/architecture.md`
System C4	`web/reference/system-c4.md`
API & store UML	`web/reference/api-uml.md`
Site wireframes	`web/reference/site-wireframes.md`
Site person identity	`web/reference/site-person.md` (formal / casual / short names)
Process sequences	`web/reference/process-sequences.md`
TypeScript types	`web/reference/types.md`
TypeScript config	`web/reference/typescript-config.md`

Topic	Path
Packages index	`packages/README.md`
`@tgmc/utilities`	`packages/utilities.md`
`@tgmc/theme`	`packages/theme.md` (brand vs hue, `data-fit`, ratios)

Topic	Path
Dev tooling index	`dev/README.md`
Git hooks	`dev/git-hooks.md`
GitHub access	`dev/github-access.md`
npm overrides	`dev/npm-security-overrides.md`
Encapsulation	`dev/encapsulation-remediation.md`

These directories are not built into Pages. Open them on GitHub:

Path	Use
`core/web/`	Nuxt app; `nuxt.config.ts`
`docker/`	Compose + Dockerfiles; Docker
`infra/sam/`	SAM template; SAM / AWS
`packages/`	`utilities`, `media-player`, `likwidlibs`
`theme/core/`	`@tgmc/theme`
`scripts/`	migrate, SAM, GitHub env, `update-agents.mjs`
`.github/workflows/`	CI/CD YAML; CI/CD