Plans the Over mij page
Refreshes the reverse engineering docs after the homepage sections and records the requirements, execution plan and application design for the Over mij page: live texts in the design's structure, an indexed page with its own structured data and preview image, and shared building blocks (PageSection, MediaText, Eyebrow) reused by the homepage. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,65 @@
|
||||
# Application Design Plan — Over mij Page
|
||||
|
||||
Depth: minimal. Business rules (structured data, content model with inline links) follow in Functional Design for unit 2.
|
||||
|
||||
## Plan
|
||||
|
||||
- [x] Answer the design questions below
|
||||
- [x] Generate `components.md` — new and changed components with responsibilities and interfaces
|
||||
- [x] Generate `component-methods.md` — props and function signatures (incl. the new SEO builders)
|
||||
- [x] Generate `services.md` — composition in the route (there is no service layer in this SPA)
|
||||
- [x] Generate `component-dependency.md` — dependency matrix and data flow
|
||||
- [x] Generate `application-design.md` — consolidated design
|
||||
- [x] Validate completeness and consistency against requirements.md
|
||||
|
||||
## Already decided (no question needed)
|
||||
|
||||
- **`PageSection`** = `HomeSection` renamed, same props. One addition for this page: a way to drop the top padding, because the first block sits directly under the page head (design `.section--flush-top`), e.g. `spacing="flushTop"`.
|
||||
- **SEO**: the structured data builders (`aboutPage(...)`, `person(...)`) are pure functions in `seo.ts`, next to `professionalService`. The route's `head()` combines `pageHead('/over-mij')` with one extra `application/ld+json` script; the business gets a stable `@id`. The page registry (`sitePages.ts`) stays limited to title, description, indexed and `ogImage`.
|
||||
- **Content**: `content/aboutContent.ts` + `AboutPageContent` in `content/types.ts`, passed in from the route (same pattern as the homepage). The exact shape of a paragraph with inline links is defined in Functional Design.
|
||||
- **Booking button**: the existing `LinkButton` with `variant="accent"`; links in text use `Link variant="underline"` + `RouterLink`.
|
||||
|
||||
---
|
||||
|
||||
Vul per vraag de letter in na `[Answer]:`. Past geen enkele optie, kies dan de laatste (Anders) en licht toe.
|
||||
|
||||
## Vraag 1: Interface van het gedeelde blok "foto naast tekst" (`MediaText`)
|
||||
|
||||
Het blok wordt gebruikt door `AboutBlock` op de homepage (eyebrow + h2 + 3 alinea's + link "Lees mijn verhaal") en door "Hoi! Ik ben Andrea" hier (eyebrow + h2 + 3 alinea's, waarvan één met twee links).
|
||||
|
||||
- A) **Alleen layout**: `MediaText` krijgt de foto (`image`, `aspectRatio`) en de tekstkolom als `children`. Elk gebruik vult zelf de kop en de tekst in met `SectionHeading`, `Text` en links. Flexibel, en de inhoud blijft bij de pagina die hem kent. (aanbevolen)
|
||||
- B) **Inhoud als data**: `MediaText` krijgt `{ eyebrow, title, paragraphs, image, link? }` en rendert alles zelf. Minder code per gebruik, maar inline links in een alinea en verschillen tussen de twee pagina's moeten dan via extra props.
|
||||
- X) Anders (beschrijf hieronder na de [Answer]:-tag)
|
||||
|
||||
[Answer]: A
|
||||
|
||||
## Vraag 2: De h3-koppen in labelstijl ("Hoe het begon", "Buiten de camera om")
|
||||
|
||||
De labelstijl (klein, hoofdletters, ruime letterafstand, `accent.deep`) staat nu twee keer los uitgeschreven: in `SectionHeading` en in `PageIntro`, beide als `Text`.
|
||||
|
||||
- A) **Eén `Eyebrow`-component** met een `as`-prop: standaard een gewone tekst, en met `as="h3"` een kop. `SectionHeading` en `PageIntro` gaan hem ook gebruiken, zodat de labelstijl (tekststijl + kleur + marge) op één plek staat. (aanbevolen)
|
||||
- B) `SectionHeading` uitbreiden met een optie die alleen een label als kop rendert (bijvoorbeeld `level="h3"` zonder titel)
|
||||
- C) Per sectie direct `<Heading as="h3" textStyle="eyebrow" color="accent.deep">` schrijven, zonder nieuwe component
|
||||
- X) Anders (beschrijf hieronder na de [Answer]:-tag)
|
||||
|
||||
[Answer]: A
|
||||
|
||||
## Vraag 3: De twee foto's naast elkaar
|
||||
|
||||
In het ontwerp is dit een variant van de introgalerij van de homepage (`.intro-gallery--duo`): 2 kolommen, liggend 3:2, geen verspringing en geen swipe-rij op telefoons (daar onder elkaar). `IntroGallery` is nu een complete homepage-sectie, met de kop en de swipe-rij erin.
|
||||
|
||||
- A) **Nieuwe kleine component `PhotoDuo`** (of algemener `PhotoGrid` met een aantal kolommen), die `DeferredImage` en de theme-tokens hergebruikt. `IntroGallery` blijft zoals hij is. Simpel, want het gedrag verschilt duidelijk. (aanbevolen)
|
||||
- B) **Eén gedeelde galerijcomponent** uit `IntroGallery` halen met de varianten `staggered` (homepage) en `duo` (hier), en `IntroGallery` daarop laten draaien. Meer hergebruik, maar wel een component met varianten die zich anders gedragen (wel of geen swipe-rij, wel of geen verspringing).
|
||||
- X) Anders (beschrijf hieronder na de [Answer]:-tag)
|
||||
|
||||
[Answer]: A
|
||||
|
||||
## Vraag 4: Waar komen de onderdelen van deze pagina?
|
||||
|
||||
De homepage-secties staan in `components/home/`. Deze pagina heeft twee tekstblokken met dezelfde opbouw ("Hoe het begon" en "Buiten de camera om": smalle kolom, h3-label, alinea's, optioneel iets eronder zoals de knop).
|
||||
|
||||
- A) **`components/about/`** met de pagina-specifieke delen (bijvoorbeeld `AboutIntro` en één `StorySection` voor beide tekstblokken). Gedeelde bouwstenen (`MediaText`, `Eyebrow`, `PhotoDuo`, `PageSection`) staan elk in een eigen map direct onder `components/`. Dezelfde indeling als de homepage. (aanbevolen)
|
||||
- B) Alles direct in de route `routes/over-mij.tsx` opbouwen met de gedeelde bouwstenen, zonder pagina-specifieke componenten
|
||||
- X) Anders (beschrijf hieronder na de [Answer]:-tag)
|
||||
|
||||
[Answer]: A
|
||||
@@ -0,0 +1,159 @@
|
||||
# Execution Plan — Over mij Page
|
||||
|
||||
## Detailed Analysis Summary
|
||||
|
||||
### Transformation Scope (Brownfield)
|
||||
- **Transformation Type**: Single component (`web/`), application-level only
|
||||
- **Primary Changes**: replace the `/over-mij` placeholder with the real page; rename the shared section frame (`HomeSection` → `PageSection`); extract a shared media+text block from the homepage `AboutBlock`; page-specific SEO (indexing, title/description, `AboutPage`/`Person` JSON-LD, own preview image)
|
||||
- **Related Components**: `web/src/routes/over-mij.tsx`, `web/src/components/{HomeSection,home/AboutBlock,…}`, `web/src/content/`, `web/src/seo.ts`, `web/src/sitePages.ts`, `web/lighthouserc*.cjs`, `web/public/`, `web/src/assets/`, [LAYOUT.md](../../../../../LAYOUT.md)
|
||||
|
||||
### Change Impact Assessment
|
||||
- **User-facing changes**: Yes — a new page; the homepage must look and behave exactly as before
|
||||
- **Structural changes**: Minor — one component renamed, one shared component extracted; no architectural change
|
||||
- **Data model changes**: Yes (small) — new `AboutPageContent` interface; `HomeContent['about']` may share a type with the new block
|
||||
- **API changes**: No external API; internal component props change for the extracted block
|
||||
- **NFR impact**: Yes — SEO (the page becomes indexed and gets structured data), accessibility (heading outline h1/h2/h3), performance (new photos; Lighthouse budget 0.9 for this page)
|
||||
|
||||
### Component Relationships
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
Route["routes/over-mij.tsx"] --> PageIntro["PageIntro (existing)"]
|
||||
Route --> PageSection["PageSection (renamed from HomeSection)"]
|
||||
Route --> MediaText["MediaText (new, extracted)"]
|
||||
Route --> Duo["Photo duo (new or composed)"]
|
||||
Route --> LinkButton["LinkButton accent (existing)"]
|
||||
Home["routes/index.tsx + components/home/*"] --> PageSection
|
||||
AboutBlock["home/AboutBlock"] --> MediaText
|
||||
MediaText --> FramedImage["FramedImage + DeferredImage (existing)"]
|
||||
Route --> Content["content/aboutContent.ts (new)"]
|
||||
Route --> Seo["seo.ts + sitePages.ts (extended)"]
|
||||
Seo --> Lhci["lighthouserc*.cjs (indexed paths)"]
|
||||
classDef newpart fill:#FFA726,stroke:#E65100,stroke-width:1px,color:#000;
|
||||
classDef changed fill:#63b3ed,stroke:#2b6cb0,stroke-width:1px,color:#000;
|
||||
classDef existing fill:#e2e8f0,stroke:#4a5568,stroke-width:1px,color:#000;
|
||||
class Route,MediaText,Duo,Content newpart;
|
||||
class PageSection,Home,AboutBlock,Seo,Lhci changed;
|
||||
class PageIntro,LinkButton,FramedImage existing;
|
||||
```
|
||||
|
||||
Text alternative: the new route composes PageIntro, the renamed PageSection, the new shared MediaText block, a photo duo and LinkButton from new content and extended SEO modules; the homepage and AboutBlock switch to PageSection and MediaText; Lighthouse config follows the SEO registry.
|
||||
|
||||
- **Primary Component**: `web` (front-end SPA)
|
||||
- **Shared Components**: `PageSection` (Major rename, every homepage section imports it), `MediaText` (new, used by `AboutBlock`), `seo.ts` (Minor, new functions)
|
||||
- **Dependent Components**: the six homepage sections (import path change only)
|
||||
- **Supporting Components**: Lighthouse CI config (Configuration-only), LAYOUT.md (documentation)
|
||||
|
||||
### Risk Assessment
|
||||
- **Risk Level**: Low
|
||||
- **Rollback Complexity**: Easy (one branch, commits per unit)
|
||||
- **Testing Complexity**: Simple — existing component and route tests guard the homepage during the refactor; new page tests and Lighthouse cover the page
|
||||
|
||||
## Workflow Visualization
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
Start(["User Request"])
|
||||
|
||||
subgraph INCEPTION["🔵 INCEPTION PHASE"]
|
||||
WD["Workspace Detection<br/><b>COMPLETED</b>"]
|
||||
RE["Reverse Engineering<br/><b>COMPLETED</b>"]
|
||||
RA["Requirements Analysis<br/><b>COMPLETED</b>"]
|
||||
US["User Stories<br/><b>SKIP</b>"]
|
||||
WP["Workflow Planning<br/><b>IN PROGRESS</b>"]
|
||||
AD["Application Design<br/><b>EXECUTE</b>"]
|
||||
UG["Units Generation<br/><b>SKIP</b>"]
|
||||
end
|
||||
|
||||
subgraph CONSTRUCTION["🟢 CONSTRUCTION PHASE"]
|
||||
FD["Functional Design<br/><b>EXECUTE (unit 2)</b>"]
|
||||
NFRA["NFR Requirements<br/><b>SKIP</b>"]
|
||||
NFRD["NFR Design<br/><b>SKIP</b>"]
|
||||
ID["Infrastructure Design<br/><b>SKIP</b>"]
|
||||
CG["Code Generation<br/>(Planning + Generation)<br/><b>EXECUTE</b>"]
|
||||
BT["Build and Test<br/><b>EXECUTE</b>"]
|
||||
end
|
||||
|
||||
Start --> WD
|
||||
WD --> RE
|
||||
RE --> RA
|
||||
RA --> WP
|
||||
WP --> AD
|
||||
AD --> FD
|
||||
FD --> CG
|
||||
CG --> BT
|
||||
BT --> End(["Complete"])
|
||||
|
||||
style WD fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style RE fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style RA fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style WP fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style CG fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style BT fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
||||
style AD fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
||||
style FD fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
||||
style US fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style UG fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style NFRA fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style NFRD fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style ID fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style INCEPTION fill:#BBDEFB,stroke:#1565C0,stroke-width:3px,color:#000
|
||||
style CONSTRUCTION fill:#C8E6C9,stroke:#2E7D32,stroke-width:3px,color:#000
|
||||
style Start fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
||||
style End fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
||||
|
||||
linkStyle default stroke:#333,stroke-width:2px
|
||||
```
|
||||
|
||||
Text alternative: completed Workspace Detection, Reverse Engineering and Requirements Analysis lead to Workflow Planning, then Application Design, Functional Design (unit 2 only), Code Generation per unit and Build and Test; User Stories, Units Generation, NFR Requirements, NFR Design, Infrastructure Design and the Operations phase are skipped.
|
||||
|
||||
## Phases to Execute
|
||||
|
||||
### 🔵 INCEPTION PHASE
|
||||
- [x] Workspace Detection (COMPLETED)
|
||||
- [x] Reverse Engineering (COMPLETED — refresh)
|
||||
- [x] Requirements Analysis (COMPLETED)
|
||||
- [x] User Stories (SKIPPED)
|
||||
- **Rationale**: one persona (the visitor), concrete FRs with exact texts and link targets; stories would restate the requirements
|
||||
- [x] Execution Plan (IN PROGRESS)
|
||||
- [ ] Application Design - EXECUTE (minimal depth)
|
||||
- **Rationale**: new and changed shared components need agreed boundaries and props before code: `PageSection` (rename), `MediaText` (extracted from `AboutBlock`), the h3 eyebrow-style heading (component, text style or `SectionHeading` option), the photo duo, `AboutPageContent`, and where the new SEO functions live
|
||||
- [ ] Units Generation - SKIP
|
||||
- **Rationale**: the split is obvious and fixed below (two units); no separate unit-of-work artifacts needed
|
||||
|
||||
### 🟢 CONSTRUCTION PHASE
|
||||
- [ ] Functional Design - EXECUTE for unit 2 only (minimal depth)
|
||||
- **Rationale**: the structured data has rules (what goes into `Person`/`AboutPage`, `@id` linking, no e-mail, only valid socials) and PBT-01 requires its properties to be identified in design; the content model with inline links needs a definition. Unit 1 is a behaviour-preserving refactor with nothing to design beyond Application Design
|
||||
- [ ] NFR Requirements - SKIP
|
||||
- **Rationale**: NFRs are set at requirements level (NFR-OM-01..06) and the stack is fixed
|
||||
- [ ] NFR Design - SKIP
|
||||
- **Rationale**: no new NFR patterns; existing ones (DeferredImage, Reveal, theme focus ring, jsonLdScript) are reused
|
||||
- [ ] Infrastructure Design - SKIP
|
||||
- **Rationale**: static assets only; no server config, CSP or deployment changes
|
||||
- [ ] Code Generation - EXECUTE (ALWAYS, per unit)
|
||||
- **Rationale**: implementation and tests
|
||||
- [ ] Build and Test - EXECUTE (ALWAYS)
|
||||
- **Rationale**: full `pnpm check` incl. Lighthouse for `/` and `/over-mij`
|
||||
|
||||
### 🟡 OPERATIONS PHASE
|
||||
- [ ] Deployment Setup, Monitoring Setup, Production Readiness Validation - SKIP
|
||||
- **Rationale**: Operations Configuration = No (decided at Requirements Analysis); the existing pipeline deploys to test on merge
|
||||
|
||||
## Units of Work (in order)
|
||||
|
||||
| # | Unit | Scope | Requirements |
|
||||
|---|---|---|---|
|
||||
| 1 | **Shared blocks** | Rename `HomeSection` → `PageSection` (folder, component, test, imports); extract the shared media+text block and switch `AboutBlock` to it. No visible change on the homepage. | FR-OM-09, FR-OM-10, NFR-OM-02 |
|
||||
| 2 | **Over mij page** | Photos (download, resize, alt texts) and preview image; `aboutContent.ts` + types; the page sections and photo duo; links and button; SEO (indexed, title/description, `ogImage`, `AboutPage`/`Person` JSON-LD, Lighthouse indexed paths); LAYOUT.md | FR-OM-01..08, SEO-OM-01..05, NFR-OM-01, 03..06 |
|
||||
|
||||
Unit 1 goes first because unit 2 builds on its components. Each unit: one or more commits on `feature/over-mij-page`, full `pnpm check` (incl. Lighthouse) before its completion message; one PR to master at the end.
|
||||
|
||||
## Estimated Timeline
|
||||
- **Total Stages to execute from here**: 5 (Application Design, Functional Design for unit 2, Code Generation ×2 units, Build and Test)
|
||||
- **Estimated Duration**: one to two working sessions
|
||||
|
||||
## Success Criteria
|
||||
- **Primary Goal**: a finished, indexed Over mij page that matches the design with the live texts
|
||||
- **Key Deliverables**: `/over-mij` page; `PageSection` and the shared media+text block; `aboutContent.ts`; new SEO functions with tests; resized photos and a 1200×630 preview image; updated LAYOUT.md and Lighthouse config
|
||||
- **Quality Gates**: `pnpm check` passes (lint, format, tests with coverage thresholds, build, audits, Lighthouse: accessibility 1.0, best practices 1.0, performance ≥ 0.9 for `/over-mij`, homepage budgets unchanged); axe clean; homepage output unchanged after unit 1
|
||||
- **Integration Testing**: route tests render `/` and `/over-mij` in the shell; navigation to `/#contact` from the page lands on the contact section
|
||||
Reference in New Issue
Block a user