docs: update resume PDF specs — add Download Resume UI and mark items implemented

- Add Download Resume UI spec: single button with dropdown on desktop,
  2 separate buttons on mobile (≥769px breakpoint)
- Mark Version Stamping and Multiple Language Versions as implemented
  in both spec files
- Add implementation details for version stamping and i18n in future spec
- Future spec version 0.2.0 — Partial (2/4 implemented)
This commit is contained in:
dong.nguyen committed 2026-10-12 15:23:23 +07:00
1 parent 1f20f36180
commit 1b5c55fbaf
2 files changed
+188 -36

No files matched your search

@@ -1,16 +1,16 @@
# Specification — v2 Resume PDF (Future Enhancements) # Specification — v2 Resume PDF (Future Enhancements)
> **Document:** `spec-v2-resume-future.md` > **Document:** `spec-v2-resume-future.md`
> **Version:** 0.1.0 > **Version:** 0.2.0
> **Parent:** `spec-v2-resume-playwright.md` > **Parent:** `spec-v2-resume-playwright.md`
> **Status:** Deferred — not yet implemented > **Status:** Partial — 2/4 items implemented
--- ---
## Overview ## Overview
This spec covers deferred enhancements for the Resume PDF generation system. This spec covers deferred enhancements for the Resume PDF generation system.
All items in `spec-v2-resume-playwright.md` (Phase 1 + Phase 2) are fully implemented. Implemented items are marked `✅`. Deferred items remain for future work.
See [spec-v2-resume-playwright.md](./spec-v2-resume-playwright.md) for current implementation. See [spec-v2-resume-playwright.md](./spec-v2-resume-playwright.md) for current implementation.
@@ -18,45 +18,144 @@ See [spec-v2-resume-playwright.md](./spec-v2-resume-playwright.md) for current i
## 1. Version Stamping ## 1. Version Stamping
**Status:** DEFERRED **Status:** ✅ Implemented
Add footer "Last updated: YYYY-MM-DD" to each PDF page. Add footer "Last updated: YYYY-MM-DD" to each PDF page.
**Implementation:** **Implementation:**
- Script injects footer into HTML template: `{{UPDATED_DATE}}` - Script (dòng 62-63): `new Date().toISOString().slice(0, 10)` → `updatedDate`
- Or use JavaScript in the page to inject dynamic date: - Template (dòng 295-298): `<div class="pdf-footer">Last updated: {{UPDATED_DATE}}</div>`
- CSS (dòng 248-257): `.pdf-footer` — center, 8pt, `#999`, border-top, `page-break-inside: avoid`
- Replace (dòng 151): `.replace('{{UPDATED_DATE}}', updatedDate)`
```typescript **Output:** Footer "Last updated: 2026-10-12" xuất hiện ở cuối mỗi PDF.
await page.evaluate((date: string) => {
const footer = document.createElement('div');
footer.className = 'pdf-footer';
footer.textContent = `Last updated: ${date}`;
document.body.appendChild(footer);
}, new Date().toISOString().slice(0, 10));
```
**CSS:**
```css
.pdf-footer {
page-break-inside: avoid;
text-align: center;
font-size: 8pt;
color: #999;
margin-top: 16px;
padding-top: 8px;
border-top: 1px solid #eee;
}
```
--- ---
## 2. Multiple Language Versions ## 2. Multiple Language Versions
**Status:** DEFERRED (English only) **Status:** ✅ Implemented
Support PDF in English + Vietnamese. Currently English only. Support PDF in English + Vietnamese.
**Approach:** **Implementation:**
- Duplicate template: `resume-template-en.html`, `resume-template-vi.html` - **Type:** `Language = 'en' | 'vi'` trong `src/types/index.ts`
- Script runs twice, outputting `resume-en.pdf`, `resume-vi.pdf` - **Data fields:** Optional `*En` fields trên Profile, ExperienceEntry, FeaturedAchievement, SkillGroup, Project, ProjectSection
- Data modules export both languages: `profile.nameEn`, `profile.nameVi` - **Resolver:** `resolveField<T>(en?: T, vi?: T)` — chọn `en` khi `lang='en'`, ngược lại chọn `vi` (fallback về `en`)
- **Labels:** `Experience/Kinh nghiệm`, `Skills/Kỹ năng`, `Projects/Dự án`
- **CLI arg:** `--lang=en` (default), `--lang=vi`
- **Output:** `resume.pdf` (EN), `resume-vi.pdf` (VI)
- **CI:** Chạy 2 lần, upload 2 artifacts, deploy cả 2
- **Local script:** `build:resume-all` chạy cả 2 ngôn ngữ
**Data bilingual coverage:**
| Module | Fields bilingual |
|--------|-----------------|
| `profile.ts` | `titleEn`, `taglineEn`, `bioEn`, `philosophy[].titleEn`, `philosophy[].descriptionEn` |
| `experience.ts` | `titleEn`, `responsibilitiesEn`, `achievements[].titleEn`, `contextEn`, `impactEn` |
| `projects.ts` | `titleEn`, `summaryEn`, `sections[].titleEn`, `sections[].contentEn` |
| `skills.ts` | `titleEn` (optional — đã English rồi nên không cần) |
---
## 3. PDF Metadata
**Status:** DEFERRED
Set metadata in `page.pdf()` options:
```typescript
await page.pdf({
path: outputPath,
format: 'A4',
printBackground: true,
margin: { top: '20mm', right: '18mm', bottom: '20mm', left: '18mm' },
});
```
In practice, Playwright PDF does **not support** `title`/`author` directly. Alternatives:
- Inject `<meta>` tags in HTML (visible only in browser print dialog)
- Use `pdf-lib` after generation to set metadata (adds dependency)
**Recommendation:** Skip metadata — resume PDF does not need professional metadata.
---
## 4. Conditional Content
**Status:** DEFERRED
Hide contact info if using placeholder values (before publishing real data):
```typescript
if (profile.email === 'your.email@example.com') {
console.warn('⚠️ Skipping PDF generation — placeholder values detected');
process.exit(0);
}
```
---
## 5. Project Sections
**Status:** DEFERRED (only title/summary/tech/metrics rendered)
Render `ProjectSection[]` details in PDF (currently only renders title/summary/tech/metrics).
Each `ProjectSection` has a `type`: `"text" | "diagram" | "metrics" | "code"`:
```typescript
function renderProjectSections(sections: ProjectSection[]): string {
return sections.map(s => {
switch (s.type) {
case 'text':
return `<div class="project-section-text">${s.content}</div>`;
case 'diagram':
return `<div class="project-section-diagram">${s.content}</div>`;
case 'metrics':
return `<div class="project-section-metrics">${s.content}</div>`;
case 'code':
return `<pre class="project-section-code">${s.content}</pre>`;
}
}).join('');
}
```
---
## 6. Download Resume UI
**Status:** DEFERRED
Single download button with dropdown on desktop, 2 separate buttons on mobile.
**Desktop (≥769px):**
- 1 button: "Download Resume" with chevron-down icon
- On click: dropdown with 2 options:
- "English" → downloads `resume.pdf`
- "Tiếng Việt" → downloads `resume-vi.pdf`
- Dropdown uses native `<details>` element (no JS state)
```html
<details class="download-resume-dropdown">
<summary>Download Resume ▾</summary>
<div class="dropdown-options">
<a href="/resume.pdf" download class="dropdown-option">English</a>
<a href="/resume-vi.pdf" download class="dropdown-option">Tiếng Việt</a>
</div>
</details>
```
**Mobile (<769px):**
- 2 separate buttons (current layout):
- "Download Resume (EN)" → `resume.pdf`
- "Download Resume (VI)" → `resume-vi.pdf`
- No dropdown, direct download links
**Implementation Notes:**
- Use native `<details>`/`<summary>` for dropdown — no React state needed
- `download` attribute on `<a>` triggers browser download
- Dropdown should close when an option is clicked (native `<details>` behavior)
- Mobile: keep existing 2-button layout in `DownloadResume.tsx` using `resumeLanguages.map()`
- Desktop: wrap in `<details>` dropdown, render only "Download Resume" as summary
@@ -769,15 +769,68 @@ will show because `/resume.pdf` exists on the server.
--- ---
## Future Enhancements
## Download Resume UI
### Component: `DownloadResume`
Single download button with dropdown menu on desktop, 2 separate buttons on mobile.
**Desktop (≥769px):**
- 1 button: "Download Resume" with chevron-down icon
- On click: dropdown with 2 options:
- "English" → downloads `resume.pdf`
- "Tiếng Việt" → downloads `resume-vi.pdf`
- Dropdown uses native `<details>` element (no JS state)
```html
<details class="download-resume-dropdown">
<summary>Download Resume ▾</summary>
<div class="dropdown-options">
<a href="/resume.pdf" download class="dropdown-option">English</a>
<a href="/resume-vi.pdf" download class="dropdown-option">Tiếng Việt</a>
</div>
</details>
```
**Mobile (<769px):**
- 2 separate buttons (current layout):
- "Download Resume (EN)" → `resume.pdf`
- "Download Resume (VI)" → `resume-vi.pdf`
- No dropdown, direct download links
### Component: Hero CTA
**Desktop (≥769px):**
- Same dropdown pattern as `DownloadResume`
- Single "Download Resume" button with dropdown
**Mobile (<769px):**
- 2 separate buttons (current layout)
- "Download Resume (EN)" and "Download Resume (VI)"
### CSS Breakpoint
Use `@media (min-width: 769px)` for desktop dropdown layout, `@media (max-width: 768px)` for mobile 2-button layout.
### Implementation Notes
- Use native `<details>`/`<summary>` for dropdown — no React state needed
- `download` attribute on `<a>` triggers browser download
- Dropdown should close when an option is clicked (native `<details>` behavior)
- Mobile: keep existing 2-button layout in `DownloadResume.tsx` using `resumeLanguages.map()`
- Desktop: wrap in `<details>` dropdown, render only "Download Resume" as summary
---
## Future Enhancements
Deferred items are tracked in [`spec-v2-resume-future.md`](./spec-v2-resume-future.md): Deferred items are tracked in [`spec-v2-resume-future.md`](./spec-v2-resume-future.md):
| # | Enhancement | Status | | # | Enhancement | Status |
|---|-------------|--------| |---|-------------|--------|
| 1 | PDF Metadata (title/author) | Deferred | | 1 | PDF Metadata (title/author) | Deferred |
| 2 | Version Stamping (footer date) | Deferred | | 2 | Version Stamping (footer date) | ✅ Implemented |
| 3 | Conditional Content (placeholder detection) | Deferred | | 3 | Conditional Content (placeholder detection) | Deferred |
| 4 | Project Sections (render text/diagram/metrics/code) | Deferred | | 4 | Project Sections (render text/diagram/metrics/code) | Deferred |
| 5 | Multiple Language Versions (EN + VI) | Deferred | | 5 | Multiple Language Versions (EN + VI) | ✅ Implemented |