Skip to content

Commit 5c32e01

Browse files
author
DavidQ
committed
BUILD_PR: improve samples browse visuals and navigation
- add thumbnail / preview asset support with clean fallback behavior - add lightweight hover preview behavior - polish next/previous/related navigation surfaces - preserve canonical paths and metadata-driven readable UI No gameplay or engine-core scope included
1 parent 6d3fd87 commit 5c32e01

10 files changed

Lines changed: 622 additions & 155 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 73 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,79 @@
1-
# Codex command for PLAN_PR_SAMPLES_BUNDLED_FINALIZATION
1+
# Codex command for BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION
22

33
MODEL: GPT-5.4-codex
44
REASONING: high
55

66
COMMAND:
7-
Create PLAN_PR_SAMPLES_BUNDLED_FINALIZATION as docs-only planning.
8-
9-
OBJECTIVE:
10-
Bundle the remaining samples PRs into the fewest rule-safe BUILD/APPLY waves.
11-
12-
CONSTRAINTS:
13-
- docs only
14-
- no implementation code
15-
- preserve one PR purpose only
16-
- preserve testability gate
17-
- preserve canonical sample paths
18-
- no gameplay scope
19-
- no engine-core scope
20-
- no start_of_day directory changes
21-
22-
PLANNING REQUIREMENTS:
23-
1. Cover all 7 remaining sample objectives
24-
2. Minimize the number of future BUILD/APPLY waves
25-
3. Do not combine incompatible purposes into one BUILD
26-
4. Keep each future BUILD testable
27-
5. Keep Windows-safe zero-dependency execution assumptions intact
28-
29-
OUTPUT FILES:
30-
- docs/pr/PLAN_PR_SAMPLES_BUNDLED_FINALIZATION.md
31-
- docs/dev/codex_commands.md
32-
- docs/dev/commit_comment.txt
33-
- docs/dev/reports/change_summary.txt
34-
- docs/dev/reports/validation_checklist.txt
35-
- docs/dev/reports/file_tree_delta.txt
36-
37-
ZIP OUTPUT REQUIREMENT:
7+
Execute BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION exactly as written.
8+
9+
EXECUTION ENVIRONMENT (MANDATORY):
10+
- Target platform: Windows
11+
- Prefer Node.js or vanilla JS for any scripting or generation support
12+
- DO NOT run `npm install`
13+
- DO NOT create `package.json`
14+
- DO NOT create `package-lock.json`
15+
- DO NOT create or populate `node_modules/`
16+
- DO NOT use PowerShell for path construction, rename-heavy work, or ZIP path generation
17+
18+
POWERSHELL PROHIBITION (CRITICAL):
19+
The following patterns are NOT allowed:
20+
- "$var/path"
21+
- "${var}/path"
22+
- "$base\$child"
23+
- "$($var)/path"
24+
25+
If any of these appear:
26+
- STOP
27+
- report the violation
28+
- do not silently retry
29+
30+
PR PURPOSE:
31+
Improve samples browse visuals and navigation in one narrow, testable wave.
32+
33+
EXPECTED TARGETS:
34+
- `samples/index.html`
35+
- minimal JS/CSS directly supporting thumbnails and hover preview
36+
- minimal sample detail page files directly supporting navigation polish
37+
- metadata-driven files directly needed for preview and navigation rendering
38+
- reporting docs under `docs/`
39+
40+
DO NOT:
41+
- modify gameplay code
42+
- modify engine core
43+
- change canonical paths
44+
- broaden scope beyond browse visuals and navigation
45+
- modify `docs/dev/start_of_day/chatGPT/`
46+
- modify `docs/dev/start_of_day/codex/`
47+
48+
REQUIRED IMPLEMENTATION SHAPE:
49+
1. Add thumbnail / preview asset support with clean fallback behavior
50+
2. Keep hover preview lightweight and dependency-free
51+
3. Polish next / previous / related navigation as needed
52+
4. Preserve canonical links and metadata-driven readable UI
53+
5. Keep changed-file count minimal
54+
55+
VALIDATION (REQUIRED):
56+
- load `samples/index.html`
57+
- verify thumbnails render when available
58+
- verify fallback behavior when previews are missing
59+
- verify hover preview does not break layout
60+
- open representative sample pages and validate navigation
61+
- confirm Phase 13 samples 1316, 1317, 1318 still load
62+
- confirm console is clean for tested pages
63+
- report exact files changed
64+
- report exact validation performed
65+
66+
ZIP OUTPUT REQUIREMENT (HARD RULE):
3867
- MUST produce ZIP:
39-
<project folder>/tmp/PLAN_PR_SAMPLES_BUNDLED_FINALIZATION.zip
40-
- Task is not complete until the ZIP exists at that exact path
68+
<project folder>/tmp/BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION.zip
69+
- ZIP must contain only repo-relevant delta output for this PR
70+
- Do not stage ZIP files from `<project folder>/tmp/`
71+
- Task is NOT complete until the ZIP exists at the exact requested path
72+
73+
FAIL FAST:
74+
- vague target files
75+
- broad asset reorganization required
76+
- preview conventions too inconsistent to implement narrowly
77+
- navigation changes require unrelated page rewrites
78+
- PowerShell parse issue before execution
79+
- missing ZIP output at exact path

docs/dev/COMMIT_COMMENT.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
PLAN_PR: bundle remaining sample objectives into minimal safe BUILD/APPLY waves
1+
BUILD_PR: improve samples browse visuals and navigation
22

3-
- covers all 7 remaining sample objectives
4-
- minimizes future execution to 3 BUILD/APPLY waves
5-
- preserves one-purpose-per-PR rule and testability gate
6-
- preserves canonical sample paths and Windows-safe zero-dependency assumptions
3+
- add thumbnail / preview asset support with clean fallback behavior
4+
- add lightweight hover preview behavior
5+
- polish next/previous/related navigation surfaces
6+
- preserve canonical paths and metadata-driven readable UI
77

8-
Docs-only planning bundle
8+
No gameplay or engine-core scope included
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION
2+
3+
Scope confirmation:
4+
- No gameplay files changed
5+
- No engine-core files changed
6+
- Canonical sample paths preserved
7+
8+
Files changed for this BUILD:
9+
- samples/index.html
10+
- samples/_shared/sampleDetailPageEnhancement.js
11+
- samples/metadata/samples.index.metadata.json
12+
- docs/dev/reports/BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION_validation.txt
13+
14+
Validation executed:
15+
1) node scripts/generate-samples-index.mjs --check
16+
- Result: OK phases=15 samples=197 metadata=197 mode=check
17+
18+
2) node --check samples/_shared/sampleDetailPageEnhancement.js
19+
- Result: pass (no syntax errors)
20+
21+
3) samples/index.html inline script parse + visual CSS presence checks
22+
- Result: pass
23+
- Verified thumbnail and hover-preview CSS selectors exist
24+
25+
4) metadata preview entries and preview asset existence for 1316/1317/1318
26+
- Result: pass
27+
- Verified thumbnail + preview metadata fields point to existing assets
28+
29+
5) detail-page navigation model checks via shared enhancer module
30+
- Result: pass
31+
- Verified previous/next/related links resolve to canonical sample paths
32+
- Verified fallback preview/thumbnail behavior for samples without assets
33+
34+
6) hover-preview guard checks in samples/index.html
35+
- Result: pass
36+
- Verified fixed overlay behavior and non-layout-breaking guard styles
37+
38+
7) representative phase 13 sample checks
39+
- Result: pass
40+
- Verified 1316, 1317, 1318 links remain in samples/index.html
41+
- Verified 1316/1317/1318 sample pages still include enhancer + main script tags
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
PR TYPE: PLAN
2-
PURPOSE: samples bundled finalization
1+
PR TYPE: BUILD
2+
PURPOSE: samples browse visuals and navigation
33

44
SUMMARY:
5-
- defines the 7 remaining sample objectives to complete
6-
- bundles work into the minimum safe number of future BUILD/APPLY waves (3)
7-
- separates browse UX, discovery-data quality, and performance/personalization into compatible lanes
8-
- preserves one-purpose-per-PR, testability gates, canonical paths, and Windows-safe zero-dependency assumptions
5+
- defines a testable BUILD wave for thumbnails, hover preview, and navigation polish
6+
- preserves canonical sample paths and metadata-driven readable UI
7+
- requires clean fallback behavior when preview assets are missing
8+
- keeps scope narrow and Windows-safe

docs/dev/reports/file_tree_delta.txt

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
PLAN OUTPUT ONLY
1+
EXPECTED DELTA (implementation-dependent, keep minimal)
22

3-
ADDED/UPDATED:
4-
- docs/pr/PLAN_PR_SAMPLES_BUNDLED_FINALIZATION.md
3+
MODIFIED:
4+
- samples/index.html
5+
- minimal JS/CSS directly supporting browse visuals / hover behavior
6+
- minimal sample detail files directly supporting navigation polish
7+
8+
ADDED (only if required):
9+
- minimal preview asset mapping or helper file
10+
- minimal browse-visual support file directly used by the samples index
11+
12+
REPORT ONLY:
13+
- docs/pr/BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION.md
514
- docs/dev/codex_commands.md
615
- docs/dev/commit_comment.txt
716
- docs/dev/reports/change_summary.txt
817
- docs/dev/reports/validation_checklist.txt
918
- docs/dev/reports/file_tree_delta.txt
10-
11-
NO IMPLEMENTATION FILES IN THIS PLAN
12-
NO GAMEPLAY OR ENGINE-CORE FILES CHANGED
Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
[x] All 7 remaining sample objectives are covered
2-
[x] Bundling uses the fewest safe BUILD/APPLY waves
3-
[x] No future BUILD mixes incompatible PR purposes
4-
[x] Each future BUILD remains testable
5-
[x] Canonical path contract remains unchanged
6-
[x] Windows-safe zero-dependency assumptions remain intact
7-
[x] Output files generated at required docs paths
8-
[x] ZIP exists at <project folder>/tmp/PLAN_PR_SAMPLES_BUNDLED_FINALIZATION.zip
1+
[ ] samples/index.html renders thumbnails when available
2+
[ ] missing preview assets fall back cleanly
3+
[ ] hover preview works without breaking layout
4+
[ ] representative sample pages show correct navigation
5+
[ ] related links resolve correctly
6+
[ ] Phase 13 samples 1316, 1317, 1318 still load
7+
[ ] no console errors in tested pages
8+
[ ] no gameplay changes
9+
[ ] no engine-core changes
10+
[ ] changed-file count stayed minimal
11+
[ ] ZIP exists at <project folder>/tmp/BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION.zip
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# BUILD_PR_SAMPLES_BROWSE_VISUALS_AND_NAVIGATION
2+
3+
## Objective
4+
Implement the first bundled samples finalization wave by improving browse-time visuals and movement without changing canonical sample ownership or runtime sample behavior.
5+
6+
This BUILD covers:
7+
- preview assets and thumbnails
8+
- hover preview
9+
- navigation polish
10+
11+
Canonical path contract remains:
12+
- `samples/phaseXX/XXYY/index.html`
13+
14+
## PR Purpose
15+
One purpose only:
16+
- improve sample browsing presentation and navigation
17+
18+
## In Scope
19+
- add thumbnail / preview asset support for sample tiles and sample detail presentation
20+
- render clean fallback behavior when preview assets are missing
21+
- add or polish hover preview behavior where it improves browse-time clarity
22+
- polish sample navigation surfaces such as:
23+
- next / previous movement
24+
- related navigation presentation
25+
- browse-time movement consistency between index and detail contexts
26+
- preserve metadata-driven readable UI behavior
27+
- preserve canonical sample paths
28+
29+
## Out of Scope
30+
- no gameplay changes
31+
- no engine-core changes
32+
- no path normalization changes
33+
- no metadata schema redesign
34+
- no metadata validation hardening beyond exact immediate needs for this wave
35+
- no favorites / pinning
36+
- no performance-only tuning unless required to keep this wave functional
37+
38+
## Required Behavior
39+
1. Index tiles can display preview thumbnails when available.
40+
2. Missing thumbnails must fall back cleanly with no broken UI.
41+
3. Hover preview behavior must be lightweight and dependency-free.
42+
4. Detail-page navigation must remain correct and readable.
43+
5. Related and adjacent navigation must still resolve to canonical paths.
44+
6. Representative Phase 13 samples including 1316–1318 must continue to load correctly.
45+
46+
## Expected Targets
47+
Codex should keep reads narrow and stop if the actual required target list expands materially.
48+
49+
Expected implementation targets:
50+
- `samples/index.html`
51+
- minimal JS/CSS directly supporting index browse visuals and hover behavior
52+
- minimal sample detail page rendering files directly needed for navigation polish
53+
- metadata-driven files directly needed for preview or navigation rendering
54+
- report files under `docs/` only for output packaging
55+
56+
## Windows / Execution Constraints
57+
- target platform: Windows
58+
- prefer Node.js or vanilla JS where scripting support is needed
59+
- no `npm install`
60+
- no `node_modules`
61+
- no PowerShell path interpolation
62+
- ZIP output under `<project folder>/tmp/` is mandatory
63+
64+
## Validation Requirements
65+
Minimum required validation:
66+
- load `samples/index.html`
67+
- verify thumbnails render when assets exist
68+
- verify fallback renders cleanly when assets do not exist
69+
- verify hover preview behavior does not break layout
70+
- open representative sample pages and verify:
71+
- header still renders
72+
- next / previous navigation works
73+
- related links resolve
74+
- verify Phase 13 samples 1316, 1317, 1318 still load
75+
- verify console stays clean for tested pages
76+
77+
## Acceptance Criteria
78+
- browse visuals improve without changing canonical paths
79+
- missing preview assets do not break index or detail pages
80+
- navigation polish works and remains testable
81+
- no gameplay changes
82+
- no engine-core changes
83+
- changed-file count stays minimal
84+
- repo-structured delta ZIP is produced under `<project folder>/tmp/`
85+
86+
## Fail Fast
87+
Stop and report if:
88+
- preview support would require broad asset reorganization
89+
- thumbnail conventions are ambiguous across many samples
90+
- navigation changes would require unrelated page rewrites
91+
- implementation expands beyond browse visuals and navigation
92+
- the ZIP cannot be produced at the exact requested path

0 commit comments

Comments
 (0)