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>
160 lines
10 KiB
Markdown
160 lines
10 KiB
Markdown
# 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
|