Skip to content

Commit b2824cd

Browse files
author
DavidQ
committed
PR_DEBUG_UX_FINAL_POLISH_FULL
Finalizes the debug UX polish layer for showcase samples. Includes: - debug ON/OFF badge behavior - default preset auto-load behavior - Open Debug Panel consistency - inline mini help consistency - optional remembered state decision - optional demo mode decision
1 parent 5a96fc6 commit b2824cd

13 files changed

Lines changed: 450 additions & 53 deletions

‎docs/dev/CODEX_COMMANDS.md‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,27 @@ MODEL: GPT-5.3-codex
22
REASONING: medium
33

44
COMMAND:
5-
Execute PLAN + BUILD + APPLY for PRODUCTIZATION_ROADMAP
5+
Execute PLAN + BUILD + APPLY for DEBUG_UX_FINAL_POLISH.
6+
7+
IN SCOPE:
8+
- finalize debug ON/OFF badge behavior
9+
- finalize default preset auto-load behavior
10+
- finalize `Open Debug Panel` consistency
11+
- finalize inline mini help consistency
12+
- evaluate remembered debug state
13+
- evaluate one-click demo mode
14+
15+
TARGET SAMPLES:
16+
- Asteroids
17+
- Breakout
18+
19+
RULES:
20+
- sample-level integration only
21+
- preserve production-safe defaults
22+
- do not modify BIG_PICTURE_ROADMAP.md
23+
- if PRODUCTIZATION_ROADMAP.md is updated, use bracket-only edits only
24+
- no Track G or Track H work
625

726
OUTPUT:
8-
<project folder>/tmp/PR_PRODUCTIZATION_ROADMAP_FULL_bundle.zip
27+
Create:
28+
<project folder>/tmp/PR_DEBUG_UX_FINAL_POLISH_FULL_bundle.zip

‎docs/dev/COMMIT_COMMENT.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
PR_PRODUCTIZATION_ROADMAP_FULL
2-
docs: add productization roadmap tracker and aligned PLAN/BUILD/APPLY docs bundle
1+
PR_DEBUG_UX_FINAL_POLISH_FULL
2+
polish(debug-ux): finalize Asteroids and Breakout debug badge/preset/panel/help flows with optional remember and demo modes

‎docs/dev/NEXT_COMMAND.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
PLAN_PR_PRODUCTIZATION_TRACK_Q_UX_POLISH_PASS
1+
PLAN_PR_DEBUG_UX_CROSS_SAMPLE_SHARED_BOOT_HELPER

‎docs/dev/PRODUCTIZATION_ROADMAP.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ Do NOT change structure or wording.
2222
# TRACK P - SHOWCASE SAMPLES
2323

2424
- [x] Asteroids Debug Showcase
25-
- [X] Breakout Debug Showcase
25+
- [x] Breakout Debug Showcase
2626

2727
---
2828

2929
# TRACK Q - UX POLISH
3030

31-
- [.] Debug toggle indicator
32-
- [.] Default preset auto-load
33-
- [.] Open Debug Panel button
34-
- [.] Inline mini help
31+
- [x] Debug toggle indicator
32+
- [x] Default preset auto-load
33+
- [x] Open Debug Panel button
34+
- [x] Inline mini help
3535

3636
---
3737

@@ -47,4 +47,4 @@ Do NOT change structure or wording.
4747

4848
- [ ] Debug tour
4949
- [ ] Getting started guide
50-
- [ ] Example-driven docs
50+
- [ ] Example-driven docs

‎docs/dev/reports/change_summary.txt‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,23 @@ David Quesenberry
33
04/05/2026
44
change_summary.txt
55

6-
Executed PLAN + BUILD + APPLY for PRODUCTIZATION_ROADMAP.
6+
Executed PLAN + BUILD + APPLY for DEBUG_UX_FINAL_POLISH.
77

8-
Summary of changes:
9-
- Added/updated productization roadmap docs bundle.
10-
- Standardized roadmap tracker content in `docs/dev/PRODUCTIZATION_ROADMAP.md`.
11-
- Removed malformed symbol encoding from roadmap content.
12-
- Refreshed PR docs, command/control docs, and reports for this one PR purpose.
8+
Sample updates:
9+
- Asteroids:
10+
- added debug badge/button/help UI
11+
- finalized default preset auto-load with fallbacks
12+
- added optional `rememberDebug=1`
13+
- added optional `debugDemo=1`
14+
- Breakout:
15+
- finalized optional `rememberDebug=1`
16+
- finalized optional `debugDemo=1`
17+
- aligned mini-help and preset-status messaging
1318

14-
Scope guard:
15-
- Docs-only.
16-
- No engine/runtime/tool implementation code changed.
17-
- No edits to BIG_PICTURE roadmap.
19+
Roadmap updates:
20+
- Updated `docs/dev/PRODUCTIZATION_ROADMAP.md` with bracket-only state changes for completed UX polish items.
21+
22+
Safety:
23+
- No engine core changes.
24+
- No BIG_PICTURE roadmap edits.
25+
- No Track G/H work.

‎docs/dev/reports/file_tree.txt‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@ David Quesenberry
33
04/05/2026
44
file_tree.txt
55

6-
docs/pr/PLAN_PR_PRODUCTIZATION_ROADMAP.md
7-
docs/pr/BUILD_PR_PRODUCTIZATION_ROADMAP.md
8-
docs/pr/APPLY_PR_PRODUCTIZATION_ROADMAP.md
6+
docs/pr/PLAN_PR_DEBUG_UX_FINAL_POLISH.md
7+
docs/pr/BUILD_PR_DEBUG_UX_FINAL_POLISH.md
8+
docs/pr/APPLY_PR_DEBUG_UX_FINAL_POLISH.md
99
docs/dev/PRODUCTIZATION_ROADMAP.md
1010
docs/dev/codex_commands.md
1111
docs/dev/commit_comment.txt
1212
docs/dev/next_command.txt
1313
docs/dev/reports/change_summary.txt
1414
docs/dev/reports/validation_checklist.txt
15-
docs/dev/reports/file_tree.txt
15+
docs/dev/reports/file_tree.txt
16+
games/Asteroids/index.html
17+
games/Asteroids/main.js
18+
games/Breakout/main.js

‎docs/dev/reports/validation_checklist.txt‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@ David Quesenberry
33
04/05/2026
44
validation_checklist.txt
55

6-
[x] PLAN_PR document created/updated
7-
[x] BUILD_PR document created/updated
8-
[x] APPLY_PR document created/updated
9-
[x] Productization roadmap file exists
10-
[x] Productization roadmap includes bracket-only rule
11-
[x] Productization roadmap uses readable ASCII content
12-
[x] Scope is docs-only
13-
[x] BIG_PICTURE roadmap untouched
14-
[x] Reports refreshed
15-
[x] Repo-structured delta zip created
6+
[x] PLAN/BUILD/APPLY docs updated
7+
[x] Asteroids debug badge behavior finalized
8+
[x] Breakout debug badge behavior finalized
9+
[x] Default preset auto-load finalized for both samples
10+
[x] `Open Debug Panel` behavior consistent
11+
[x] Inline mini help consistency finalized
12+
[x] Remembered debug state evaluated and implemented as optional (`rememberDebug=1`)
13+
[x] One-click demo mode evaluated and implemented as optional (`debugDemo=1`)
14+
[x] Production-safe defaults preserved
15+
[x] No BIG_PICTURE_ROADMAP.md changes
16+
[x] PRODUCTIZATION_ROADMAP.md edits are bracket-only
17+
[x] No Track G or Track H work
1618

17-
Validation checks:
18-
- `git diff --name-only`
19-
- `Get-Content -Raw docs/dev/PRODUCTIZATION_ROADMAP.md`
20-
- `tar -tf tmp/PR_PRODUCTIZATION_ROADMAP_FULL_bundle.zip`
19+
Validation commands:
20+
- `node --check games/Asteroids/main.js`
21+
- `node --check games/Breakout/main.js`
22+
- `node --check games/Breakout/game/BreakoutScene.js`
23+
- `node -e "import('./tests/games/AsteroidsValidation.test.mjs').then(async (m)=>{await m.run(); console.log('AsteroidsValidation:PASS');})"`
24+
- `node -e "import('./tests/games/BreakoutValidation.test.mjs').then(async (m)=>{await m.run(); console.log('BreakoutValidation:PASS');})"`

‎docs/pr/APPLY_PR_DEBUG_UX_FINAL_POLISH.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/05/2026
4+
APPLY_PR_DEBUG_UX_FINAL_POLISH.md
5+
6+
# APPLY_PR_DEBUG_UX_FINAL_POLISH
7+
8+
## Apply Decision
9+
Apply BUILD_PR_DEBUG_UX_FINAL_POLISH exactly as scoped.
10+
11+
## Applied Scope
12+
- Finalized debug badge/preset/button/help behavior in Asteroids and Breakout.
13+
- Added optional remembered debug state (`rememberDebug=1`) and one-click demo mode (`debugDemo=1`) in both samples.
14+
- Updated productization roadmap using bracket-only state edits.
15+
16+
## Validation Summary
17+
- Asteroids and Breakout debug UX now follows one consistent pattern.
18+
- Production-safe defaults preserved.
19+
- Existing Asteroids and Breakout validation tests pass.
20+
- No engine-core changes.
21+
- No BIG_PICTURE roadmap changes.
22+
23+
## Output
24+
`<project folder>/tmp/PR_DEBUG_UX_FINAL_POLISH_FULL_bundle.zip`

‎docs/pr/BUILD_PR_DEBUG_UX_FINAL_POLISH.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/05/2026
4+
BUILD_PR_DEBUG_UX_FINAL_POLISH.md
5+
6+
# BUILD_PR_DEBUG_UX_FINAL_POLISH
7+
8+
## Build Summary
9+
Implemented final debug UX polish for Asteroids and Breakout with consistent sample-level behavior.
10+
11+
## Implemented Changes
12+
13+
### 1. Asteroids UX polish
14+
Updated:
15+
- `games/Asteroids/index.html`
16+
- `games/Asteroids/main.js`
17+
18+
Details:
19+
- Added `Debug: ON/OFF` badge and `Open Debug Panel` button UI.
20+
- Added two-line inline mini help.
21+
- Added optional remembered debug state (`rememberDebug=1`).
22+
- Added optional one-click demo mode (`debugDemo=1`).
23+
- Finalized default preset auto-load sequence:
24+
- `asteroidsshowcase.preset.default`
25+
- fallback `preset.apply preset.gameplay`
26+
- fallback `preset.apply preset.minimal`
27+
- Kept overlay hidden by default except in demo mode.
28+
29+
### 2. Breakout UX polish
30+
Updated:
31+
- `games/Breakout/main.js`
32+
33+
Details:
34+
- Finalized optional remembered debug state (`rememberDebug=1`).
35+
- Finalized optional one-click demo mode (`debugDemo=1`).
36+
- Kept badge/button/help behavior aligned with Asteroids.
37+
- Preserved default preset auto-load and hidden-until-open overlay behavior.
38+
39+
### 3. Productization tracker state
40+
Updated:
41+
- `docs/dev/PRODUCTIZATION_ROADMAP.md`
42+
43+
Bracket-only state updates:
44+
- `Breakout Debug Showcase` -> `[x]`
45+
- `Debug toggle indicator` -> `[x]`
46+
- `Default preset auto-load` -> `[x]`
47+
- `Open Debug Panel button` -> `[x]`
48+
- `Inline mini help` -> `[x]`
49+
50+
## Scope Safety
51+
- No engine-core changes.
52+
- No unrelated sample/game refactors.
53+
- No BIG_PICTURE roadmap edits.
54+
55+
## Validation
56+
- `node --check games/Asteroids/main.js`
57+
- `node --check games/Breakout/main.js`
58+
- `node --check games/Breakout/game/BreakoutScene.js`
59+
- `node -e "import('./tests/games/AsteroidsValidation.test.mjs')..."`
60+
- `node -e "import('./tests/games/BreakoutValidation.test.mjs')..."`

‎docs/pr/PLAN_PR_DEBUG_UX_FINAL_POLISH.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/05/2026
4+
PLAN_PR_DEBUG_UX_FINAL_POLISH.md
5+
6+
# PLAN_PR_DEBUG_UX_FINAL_POLISH
7+
8+
## Goal
9+
Finalize debug UX consistency across Asteroids and Breakout without changing engine core behavior.
10+
11+
## Workflow
12+
PLAN_PR -> BUILD_PR -> APPLY_PR
13+
14+
## In Scope
15+
- Finalize debug ON/OFF badge behavior.
16+
- Finalize default preset auto-load behavior.
17+
- Finalize `Open Debug Panel` consistency.
18+
- Finalize inline mini help consistency.
19+
- Evaluate and define remembered debug state behavior.
20+
- Evaluate and define one-click demo mode behavior.
21+
22+
## Target Samples
23+
- `games/Asteroids`
24+
- `games/Breakout`
25+
26+
## Behavior Contract
27+
1. Production-safe default remains OFF unless explicitly enabled by URL/local development defaults.
28+
2. Both samples expose the same debug UX surface:
29+
- `Debug: ON/OFF` badge
30+
- `Open Debug Panel` button
31+
- two-line mini help region
32+
3. Default preset auto-load runs only when debug is enabled.
33+
4. Remembered debug state is optional and explicit via `rememberDebug=1`.
34+
5. One-click demo mode is optional and explicit via `debugDemo=1`.
35+
6. Demo mode enables debug, applies default preset, and opens debug surfaces.
36+
37+
## Guardrails
38+
- Sample-level integration only.
39+
- No engine core changes.
40+
- Do not modify `docs/dev/BIG_PICTURE_ROADMAP.md`.
41+
- If `docs/dev/PRODUCTIZATION_ROADMAP.md` changes, bracket-only edits only.
42+
- No Track G or Track H work.
43+
44+
## Acceptance Criteria
45+
- Asteroids and Breakout share consistent badge/button/help behavior.
46+
- Preset auto-load behavior is predictable and aligned.
47+
- Remembered state and demo mode are explicit optional flows.
48+
- Production-safe defaults preserved.

0 commit comments

Comments
 (0)