Skip to the content.

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.

Media Library current architecture and UML — source-verified current components, model, sequences, lifecycle and deployment; October 14 snapshot.

Admin process current architecture and UML — source-verified current session, CRUD, CDN, media and deployment; October 14 snapshot.

Admin target architecture — proposal with October 21 implementation-status update.

This tree

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/

Agents

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.

App (@tgmc/web)

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
Site media web/features/site-media.md — manifest, metadata-only rendering, guard, import
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 (/gallery grid + feed; /docs via Work sub-nav)
App SCSS web/features/app-scss.md
Personalization web/features/personalization.md — Style Studio, setups, FOUC
Theme Studio preset research web/features/theme-studio-preset-research.md — Theme/Color/palettes → brand packs
Footer and social links web/features/footer-and-social-links.md — slim footer, AppSocialLinks
Icons web/features/icons.md — Lucide via @nuxt/icon, UiIcon
Brand marks web/features/brand-marks.md — placeholder TM monogram, wordmark, favicons, manifest, social card
Site header web/features/site-header.md — measured header, nav order, phone Menu disclosure
UI components web/features/ui-components.md — tiers, naming, API, fallback, mounted tests, UiButton, UiDialog, forms
Interaction redesign web/features/interaction-redesign.md — contrast roles, nav, browse, Studio, admin media
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
Cognitive accessibility audit web/reference/cognitive-a11y-audit.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

Packages

Topic Path
Packages index packages/README.md
@tgmc/utilities packages/utilities.md
@tgmc/theme packages/theme.md (Color/Theme APIs, brand vs hue, focus rings, data-fit, ratios)
@tgmc/image packages/image.md (sharp ingest/transform, LQIP, sanitize)
@tgmc/media packages/media.md (catalog, materialize, audit/jobs, transfer, policy)
@tgmc/media-aws packages/media-aws.md (DynamoDB/S3/SQS adapters)
@tgmc/media-postgres packages/media-postgres.md (PostgreSQL catalog/jobs/audit stores)
@tgmc/media-client packages/media-client.md (portable fetch client for media HTTP APIs)
@tgmc/media-nuxt packages/media-nuxt.md (Nuxt module mounting /api/media/*)
@tgmc/nuxt-layer-base packages/nuxt-layer-base.md (Base Nuxt layer: theme stylesheet + Sass auto-use, a11y shell components, @nuxt/a11y, Lucide icons, tgmc: feature flags and the theme-off fallback)
@tgmc/nuxt-layer-ui packages/nuxt-layer-ui.md (UI Nuxt layer: PrimeVue (optional) + the Ui* component kit, useUiStack, useAppToast, useForm, useUnsavedChangesGuard, build matrix)
@tgmc/likwidlibs:nuxt-app packages/nuxt-app-generator.md (Nuxt 4 workspace app generator)
Nuxt template layers packages/nuxt-layers.md (architecture blueprint: base + ui layers, optional features, component tiers, interfaces)

Developer tooling

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
npm audit 2026-10 solutions/security/npm-audit-vulnerabilities-2026-10.md
CodeQL regex alerts 2026-10 solutions/security/codeql-regex-backtracking-2026-10.md
Encapsulation dev/encapsulation-remediation.md

Design history (not runbooks)

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

Topic On GitHub
Locked design specs docs/superpowers/specs/
Implementation plans docs/superpowers/plans/
Feature plans docs/plans/
Portfolio architecture review (archive) October 2026 review

Code trees (on GitHub)

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

Code documentation