2026-10-06 09:58:00 +07:00
# Agent Guidelines — portfolio
## Project
2026-10-13 16:45:54 +07:00
Personal engineering portfolio — multi-page SPA built with React + TypeScript + Vite. Data-driven content from `src/data/` , styled with CSS variables supporting dark/light themes. Motion animations via `motion/react` . Bilingual resume generation (EN/VI).
2026-10-06 09:58:00 +07:00
## Tech Stack
| Layer | Tool |
|-------|------|
| Framework | React 19 |
| Language | TypeScript 6 (bundler mode, `verbatimModuleSyntax` , `noEmit` ) |
| Bundler | Vite 8 |
2026-10-06 23:42:49 +07:00
| Router | React Router v8 (`react-router` package, pinned `8.4.0` ) |
2026-10-13 16:45:54 +07:00
| Animation | motion ^14.0.0 (`motion/react` ESM entrypoint) |
2026-10-06 09:58:00 +07:00
| Linter | Oxlint 1 (`plugins: react, typescript, oxc` ) |
2026-10-13 16:45:54 +07:00
| Resume generation | playwright ^1.64.0, tsx ^4.23.15 |
2026-10-06 09:58:00 +07:00
| Package manager | pnpm |
## Commands
| Command | Description |
|---------|-------------|
| `pnpm dev` | Start dev server with HMR |
| `pnpm build` | Type-check (`tsc -b` ) then build for production |
2026-10-13 16:45:54 +07:00
| `pnpm build:resume` | Generate resume PDF (default EN) via Playwright |
| `pnpm build:resume-all` | Generate bilingual resume PDFs (EN + VI) |
2026-10-06 09:58:00 +07:00
| `pnpm lint` | Run Oxlint |
| `pnpm preview` | Preview production build locally |
2026-10-06 11:42:47 +07:00
## Routing
- `App.tsx` wraps `<BrowserRouter>` → `<Layout>` → `<Routes>` (NOT nested `<Route element>` — causes `children` not to pass)
- Layout: `<Navigation>` (top) → `<main id="main-content">` → `<Footer>` (bottom)
- All internal navigation MUST use `<Link>` /`<NavLink>` , never `<a href>` (causes full page reload)
- Footer internal links also use `<Link>` ; external links (GitHub, LinkedIn, email) keep `<a>` with `target="_blank"`
## Pages
| Route | Component | Section |
|-------|-----------|---------|
| `/` | `HomePage` | Hero + About + Expertise + Experience + Projects + Contact |
| `/about` | `AboutPage` | Full about section |
| `/experience` | `ExperiencePage` | Timeline |
| `/projects` | `ProjectsListPage` | All projects grid |
| `/projects/:id` | `ProjectDetailPage` | Single project |
2026-10-14 23:11:36 +07:00
| `/philosophy` | `PhilosophyPage` | Engineering philosophy |
2026-10-06 11:42:47 +07:00
| `/contact` | `ContactPage` | Contact info |
## Theming
2026-10-17 00:32:49 +07:00
- Two independent axes on `<html>` : lightness (`Theme` ) and color (`Palette` ), both written during render before paint
- `src/hooks/useTheme.tsx` — `ThemeProvider` + `useTheme` hook, carries both axes
- Simple toggle: `'dark'` ↔ `'light'` (no `system` variant); `resolvedTheme` — runtime resolved value (always `'dark'` or `'light'` )
- `data-theme` attribute + `localStorage` key `portfolio-theme`
- `type Palette = 'red' | 'blue'` (`src/types/index.ts` ), labels/hints in `src/data/palettes.ts` (`paletteIds` , `paletteMeta` ); default `red`
- `data-palette` attribute + `localStorage` key `portfolio-palette` ; `index.html` 's init script writes both attributes before paint
- Palette overrides in `src/index.css` are `:root[data-theme='dark'][data-palette='blue']` / `:root[data-theme='light'][data-palette='blue']` (specificity 0,3,0 — they beat the base blocks regardless of order); no blue variant exists in the `prefers-color-scheme` bridge, because the init script always writes `data-palette`
- Picker: `src/components/layout/ThemePaletteMenu.tsx` , mounted twice in `Navigation.tsx` — `variant="nav"` in `.nav-actions` (>1024px) and `variant="sheet"` inside `.mobile-menu` (≤1024px, remounted closed via `key={location.pathname}` )
2026-10-06 11:42:47 +07:00
## Data Layer
- `src/data/profile.ts` — name, title, bio, links
- `src/data/skills.ts` — skill groups → skills
2026-10-16 23:22:20 +07:00
- `src/data/experience.ts` — work history entries; optional `variant: 'current' | 'gap'` selects the timeline decoration (live node / career break)
2026-10-06 11:42:47 +07:00
- `src/data/projects.ts` — project cards with categories
2026-10-13 16:45:54 +07:00
- `src/data/resume.ts` — resume availability, supported languages, URL generation
2026-10-06 11:42:47 +07:00
## Component Structure
2026-10-06 09:58:00 +07:00
```
src/
2026-10-06 11:42:47 +07:00
components/
2026-10-17 00:32:49 +07:00
layout/ — Layout.tsx, Navigation.tsx, Footer.tsx, ThemePaletteMenu.tsx
2026-10-13 16:45:54 +07:00
sections/ — Hero, About, Expertise, Experience, Projects, Contact, HeroParticles, DownloadResume
2026-10-16 23:22:20 +07:00
ui/ — Badge, Button, SectionHeading, SocialLinks, Tag, Typewriter, AnimatedSection, InView, RollingTextLink, BackToTop
2026-10-06 11:42:47 +07:00
index.ts — barrel export
2026-10-17 00:32:49 +07:00
data/ — profile, skills, experience, projects, resume, palettes (TS modules)
2026-10-13 16:45:54 +07:00
hooks/ — useTheme.tsx, useClickOutside.ts
2026-10-14 23:11:36 +07:00
pages/ — HomePage, AboutPage, ExperiencePage, ProjectsListPage, ProjectDetailPage, PhilosophyPage, ContactPage, index.ts
2026-10-06 11:42:47 +07:00
types/ — shared TypeScript interfaces
2026-10-06 09:58:00 +07:00
```
2026-10-13 16:45:54 +07:00
## Motion & Animation
- `motion/react` v14 — ESM-first entrypoint (NOT `framer-motion` )
- `AnimatedSection.tsx` — scroll-triggered motion animation wrapper
- `InView.tsx` — viewport intersection observer motion component
- `RollingTextLink.tsx` — animated text-scrolling navigation link
- `BackToTop.tsx` — scroll-to-top floating button with AnimatePresence
- `HeroParticles.tsx` — decorative particle background (uses AnimatePresence)
## External Assets
2026-10-16 21:14:59 +07:00
- `public/fonts/` — Source Sans 3 woff2 (Regular, Medium, Semibold, Bold); used by the resume generator only — the SPA renders `system-ui`
2026-10-13 16:45:54 +07:00
- `public/icons.svg` — SVG sprite for icons
- `public/resume-template.html` — HTML template for resume PDF generation
- `public/profile-photo.webp` — profile photo
## Scripts
- `scripts/generate-resume.ts` — Playwright-based PDF resume generator (bilingual en/vi)
## Deployment
- Deployment is triggered automatically by gitea workflow `.gitea/workflows/deploy.yml`
- `nginx.conf` — production Nginx SPA routing + caching config
- `docker-compose.yaml` — Docker service for local nginx deployment
```
.gitea/
└── workflows/
└── deploy.yml
nginx.conf
docker-compose.yaml
```
2026-10-06 11:42:47 +07:00
## CSS Architecture
2026-10-16 21:14:59 +07:00
- `src/index.css` — CSS variables (`:root` dark default, `[data-theme="light"]` , plus a `prefers-color-scheme: light` bridge), global resets, typography scale
2026-10-06 11:42:47 +07:00
- `src/App.css` — component-level styles (Navigation, Footer, page sections)
- No CSS library — plain CSS with variables for theming
- `#main-content` in Layout has `style={{ flex: 1 }}` (parent `#root` is `display: flex; flex-direction: column` )
2026-10-16 21:14:59 +07:00
## Typography
2026-10-16 23:14:52 +07:00
- Scale tokens in `src/index.css` : `--text-body: 18px` , `--text-lede: 20px` , `--text-meta: 15px` , `--leading-body: 1.65` , `--measure-prose: 600px` , `--measure-page: 680px`
2026-10-16 21:14:59 +07:00
- Global: `p` = `--text-body` / `--leading-body` ; `h3` 21px, `h4` 18px, `h5` 16px, `h6` 15px
2026-10-16 23:14:52 +07:00
- Two measures: `.prose` (600px) for long-form narrative, `.prose-wide` (680px, body steps up to `--text-lede` ) for page-length prose. A lead paragraph uses `.prose-lede` (600px), or `.prose-lede lede-wide` (680px) when it sits next to a full-width grid. Non-prose columns use `.page-body` (`--measure-page` ); titles inside a column use `.subheading`
- Cards and grids take the full container width; text columns do not. `/about` and the homepage About section use `container-wide` with `.philosophy-grid` at 3 columns (2 at ≤1024px, 1 at ≤768px), the same model as `.expertise-grid`
2026-10-16 21:14:59 +07:00
- Body copy sizes come from the tokens; 12-14px literals are reserved for chrome (tags, badges, pills, footer, duration labels)
- Components MUST NOT set `fontSize` / `lineHeight` inline — use the classes above
- Font stack is `system-ui` : no webfont is loaded by the SPA. The Source Sans 3 woff2 files in `public/fonts/` are consumed only by `scripts/generate-resume.ts`
- Spec: `docs/design/specs/v3/spec-v3-typography.md`
2026-10-06 11:42:47 +07:00
## Known Issues & Gotchas
2026-10-06 23:42:49 +07:00
1. **React Router v8 routing:** Use `<Layout><Routes>...</Routes></Layout>` , NOT `<Route element={<Layout />}>` with nested routes — the latter doesn't pass `children` correctly
2. **Import path:** All router imports use `react-router` (not `react-router-dom` ) — e.g., `import { Link, useLocation } from 'react-router'`
2026-10-13 16:45:54 +07:00
3. **Animation imports:** Use `motion/react` (v14 ESM), NOT `framer-motion` — e.g., `import { motion, AnimatePresence } from 'motion/react'`
4. **Footer/Nav links:** Must use `<Link to>` , not `<a href>` for client-side navigation
2026-10-06 11:42:47 +07:00
2026-10-06 12:24:55 +07:00
## Design Specs
All specification documents are in `docs/design/` :
| File | Purpose |
|------|---------|
| `spec.md` | Main PRD — product vision, positioning, narrative, IA, acceptance criteria |
2026-10-06 12:29:49 +07:00
| `spec-v1.md` | v1 completion record — features implemented, known limitations, files summary |
2026-10-06 14:14:01 +07:00
| `spec-v2.md` | v2 index — overview, implementation order, feature list |
| `specs/ui/spec-ui-*.md` | UI specs per section (hero, about, expertise, etc.) |
| `specs/v2/spec-v2-*.md` | v2 feature specs (resume, seo, blog, analytics, testing, cicd) |
2026-10-17 00:32:49 +07:00
| `specs/v3/spec-v3-*.md` | v3 feature specs (theme colors, theme switch, theme palette switch, UI enhancements) |
2026-10-06 12:24:55 +07:00
Read `spec.md` first for product context. Read `spec-v2.md` for current feature scope.
2026-10-15 00:18:34 +07:00
### Specification Rules
When proposing or implementing changes, always include these 3 sections:
**1. Implementation Details**
- Describe every code step: what to write, edit, or delete
- List new imports, functions, props, state, CSS classes
- Identify edge cases and error handling
**2. Affected Files**
- File + line range to edit: `src/foo.ts:42-57`
- New file to create: `src/bar.ts`
- File to delete: `src/dead.ts`
**3. Progress Tracking**
- Update relevant spec with status: `TODO` / `IN_PROGRESS` / `DONE`
- Record which acceptance criteria were verified
- Format: checklist in spec or inline code comments
2026-10-06 09:58:00 +07:00
## Code Style & Linting
- TypeScript: `verbatimModuleSyntax` , `noUnusedLocals` , `noUnusedParameters` , `noFallthroughCasesInSwitch`
2026-10-06 11:42:47 +07:00
- Oxlint: `react/rules-of-hooks` = error, `react/only-export-components` = warn
2026-10-06 09:58:00 +07:00
- No framework-specific CSS library — plain CSS with CSS variables
2026-10-06 11:42:47 +07:00
- Data-driven: all content from TS modules, not hardcoded in JSX