Update .gitignore to exclude sensitive files and local artifacts. Revise README for clarity and structure, removing outdated PRD references and adding a new PRD template. Delete old PRD file and resume PDF to prevent exposure of private information.
This commit is contained in:
1 parent
8458694866
commit
5d38ebb0ef
5 files changed
+151
-186
No files matched your search
@@ -0,0 +1,85 @@
|
||||
# PRD template: professional portfolio (single-page site)
|
||||
|
||||
Use this as a starting spec when you fork or reuse this repo. Replace bracketed placeholders with your own product decisions; keep a filled copy **out of public git** if it names employers, clients, or anything you would not put on GitHub.
|
||||
|
||||
---
|
||||
|
||||
## 1. Project overview
|
||||
|
||||
A single-page portfolio that acts as your professional hub on the web. It should reflect how you want to be seen (e.g. engineer, architect, lead) and stay fast and readable on phones and desktops.
|
||||
|
||||
**Audience:** recruiters, peers, and future collaborators.
|
||||
|
||||
**Tone:** [e.g. confident, approachable, minimal hype]
|
||||
|
||||
---
|
||||
|
||||
## 2. Visual identity
|
||||
|
||||
- **Palette:** [name or description — primary / secondary / accent colors]
|
||||
- **Layout:** [e.g. clean grid, lots of whitespace, one strong hero]
|
||||
- **Motion:** [e.g. subtle scroll reveals only; or richer animation where it helps]
|
||||
- **Optional motifs:** [e.g. geography, hobby, industry — only if they support the brand]
|
||||
|
||||
---
|
||||
|
||||
## 3. Core sections (information architecture)
|
||||
|
||||
Single scroll (or minimal routes), roughly in this order:
|
||||
|
||||
1. **Hero** — Name, title line, short value proposition, photo or graphic, links (email, LinkedIn, GitHub, etc.).
|
||||
2. **Skills** — Grouped by category (languages, infra, product, etc.) at a glance.
|
||||
3. **Projects** — Cards with title, stack, link to repo or live demo.
|
||||
4. **Experience** — Roles and impact; optional PDF resume download.
|
||||
5. **Interests** — Short humanizing blurbs (optional but recommended).
|
||||
6. **Contact / footer** — How to reach you and any legal/footer links.
|
||||
|
||||
**Navigation:** [e.g. sticky header with anchor links; optional theme toggle]
|
||||
|
||||
---
|
||||
|
||||
## 4. Functional requirements
|
||||
|
||||
- **Performance:** Target strong Lighthouse scores on mobile (define numbers if you care, e.g. 90+).
|
||||
- **Accessibility:** Sensible heading order, contrast, focus states, alt text on meaningful images.
|
||||
- **SEO / sharing:** Unique title, meta description, Open Graph / Twitter cards for link previews.
|
||||
- **Hosting:** [static host / Docker on home lab / both] — note base path if not served at domain root (`/`).
|
||||
|
||||
---
|
||||
|
||||
## 5. Technical stack (suggested defaults for this repo)
|
||||
|
||||
- **Framework:** Vue 3 + Vite
|
||||
- **Styling:** Tailwind CSS
|
||||
- **Animation:** GSAP (or lighter CSS-only if you prefer)
|
||||
|
||||
Adjust in the template only if you plan to change the stack in code.
|
||||
|
||||
---
|
||||
|
||||
## 6. Content sources (this codebase)
|
||||
|
||||
| Area | Typical file(s) |
|
||||
|------|-----------------|
|
||||
| Name, links, tagline | `src/content/site.ts` |
|
||||
| Skills | `src/content/skills.ts` |
|
||||
| Projects | `src/content/projects.ts` |
|
||||
| Experience | `src/content/experience.ts` |
|
||||
| Headshot / assets | `public/` |
|
||||
| Resume PDF | `public/resume.pdf` (if you ship one) |
|
||||
| SEO / social tags | `index.html` |
|
||||
|
||||
---
|
||||
|
||||
## 7. Success criteria
|
||||
|
||||
- [ ] Reads well on a phone in under a minute.
|
||||
- [ ] All primary outbound links work.
|
||||
- [ ] Build passes (`npm run build`) and deploy path is documented.
|
||||
- [ ] [Add your own: e.g. “No unverifiable claims” or “Matches resume PDF”]
|
||||
|
||||
---
|
||||
|
||||
## 8. Out of scope (optional)
|
||||
|
||||
List what you are **not** building in v1 (blog, CMS, login area, etc.) so scope stays honest.
|
||||
Reference in new issue
Block a user