|
| 1 | +# PR — Fix Parallax Header Metadata and Toggle Label |
| 2 | + |
| 3 | +## Purpose |
| 4 | + |
| 5 | +Fix the remaining shared-shell header issues found after removing static `Header and Intro` labels. |
| 6 | + |
| 7 | +This PR is tools-only. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Observed Issues |
| 12 | + |
| 13 | +### 1. Parallax Scene Studio configuration error |
| 14 | + |
| 15 | +On page load: |
| 16 | + |
| 17 | +```txt |
| 18 | +Parallax Scene Studio — Configuration error (open title for details) |
| 19 | +``` |
| 20 | + |
| 21 | +In fullscreen: |
| 22 | + |
| 23 | +```txt |
| 24 | +Parallax Scene Studio — Configuration error (open title for details) |
| 25 | +``` |
| 26 | + |
| 27 | +This means the new no-fallback metadata rule is working, but Parallax Scene Studio is missing required metadata. |
| 28 | + |
| 29 | +### 2. Exit fullscreen generic toggle text |
| 30 | + |
| 31 | +After exiting fullscreen, the visible control text says: |
| 32 | + |
| 33 | +```txt |
| 34 | +Hide Header and Details |
| 35 | +``` |
| 36 | + |
| 37 | +This is still generic and does not include the tool name. |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Scope |
| 42 | + |
| 43 | +Target only: |
| 44 | + |
| 45 | +- Parallax Scene Studio tool registry metadata |
| 46 | +- Shared platform shell header/intro/toggle rendering |
| 47 | +- Shared platform shell CSS if needed |
| 48 | + |
| 49 | +Do not modify: |
| 50 | + |
| 51 | +- King of the Iceberg files |
| 52 | +- sample games |
| 53 | +- runtime engine files |
| 54 | +- `start_of_day` folders |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Required Behavior |
| 59 | + |
| 60 | +### Parallax Scene Studio |
| 61 | + |
| 62 | +On normal page load, visible header must show: |
| 63 | + |
| 64 | +```txt |
| 65 | +Parallax Scene Studio — <Short Description> |
| 66 | +``` |
| 67 | + |
| 68 | +Visible intro must show: |
| 69 | + |
| 70 | +```txt |
| 71 | +Parallax Scene Studio: <one-line usage/help text> |
| 72 | +``` |
| 73 | + |
| 74 | +In fullscreen, the same tool-specific header/intro must be visible. |
| 75 | + |
| 76 | +No configuration error should appear when metadata is complete. |
| 77 | + |
| 78 | +--- |
| 79 | + |
| 80 | +## Required Metadata |
| 81 | + |
| 82 | +Add or verify registry fields for `parallax-scene-studio` or its actual tool id: |
| 83 | + |
| 84 | +- `name` |
| 85 | +- `shortDescription` |
| 86 | +- `intro` or equivalent one-line usage/help text |
| 87 | + |
| 88 | +Suggested values: |
| 89 | + |
| 90 | +```js |
| 91 | +name: "Parallax Scene Studio", |
| 92 | +shortDescription: "Layered Scene & Depth Composition", |
| 93 | +intro: "Parallax Scene Studio: compose layered backgrounds, midgrounds, and foreground scene depth." |
| 94 | +``` |
| 95 | + |
| 96 | +Use existing naming conventions in `toolRegistry.js`. |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## Toggle Label Requirement |
| 101 | + |
| 102 | +Generic toggle text must not say: |
| 103 | + |
| 104 | +```txt |
| 105 | +Hide Header and Details |
| 106 | +``` |
| 107 | + |
| 108 | +Instead, it must include the active tool name. |
| 109 | + |
| 110 | +Preferred: |
| 111 | + |
| 112 | +```txt |
| 113 | +Hide <Tool Name> Details |
| 114 | +Show <Tool Name> Details |
| 115 | +``` |
| 116 | + |
| 117 | +The toggle label must update when: |
| 118 | + |
| 119 | +- page loads |
| 120 | +- tool metadata binds |
| 121 | +- entering fullscreen |
| 122 | +- exiting fullscreen |
| 123 | +- collapse/expand changes |
| 124 | + |
| 125 | +--- |
| 126 | + |
| 127 | +## Missing Metadata Rule |
| 128 | + |
| 129 | +If any tool still lacks required metadata: |
| 130 | + |
| 131 | +- show actionable configuration error |
| 132 | +- identify the missing field |
| 133 | +- include the tool id |
| 134 | +- do not silently fall back to generic text |
| 135 | + |
| 136 | +Example: |
| 137 | + |
| 138 | +```txt |
| 139 | +Parallax Scene Studio configuration error: missing shortDescription for tool id parallax-scene-studio. |
| 140 | +``` |
| 141 | + |
| 142 | +--- |
| 143 | + |
| 144 | +## Acceptance Criteria |
| 145 | + |
| 146 | +- Parallax Scene Studio no longer shows configuration error on page load. |
| 147 | +- Parallax Scene Studio no longer shows configuration error in fullscreen. |
| 148 | +- Parallax Scene Studio normal header includes tool name. |
| 149 | +- Parallax Scene Studio fullscreen header includes tool name. |
| 150 | +- Parallax Scene Studio intro includes tool name. |
| 151 | +- Exiting fullscreen does not show generic `Hide Header and Details`. |
| 152 | +- Toggle text includes active tool name. |
| 153 | +- Missing metadata still produces actionable errors for genuinely incomplete tools. |
| 154 | +- No CSS-only masking of stale generic labels. |
| 155 | +- No KOTI/sample/runtime/start_of_day files change. |
| 156 | + |
| 157 | +--- |
| 158 | + |
| 159 | +## Targeted Validation |
| 160 | + |
| 161 | +Do not run long sample suites. |
| 162 | + |
| 163 | +Run only relevant checks: |
| 164 | + |
| 165 | +```powershell |
| 166 | +node --check tools/shared/platformShell.js |
| 167 | +node --check tools/toolRegistry.js |
| 168 | +``` |
| 169 | + |
| 170 | +If another JS file changes, run `node --check` on that file only. |
| 171 | + |
| 172 | +Browser validation: |
| 173 | + |
| 174 | +- Open Parallax Scene Studio. |
| 175 | +- Confirm normal header/intro text. |
| 176 | +- Enter fullscreen. |
| 177 | +- Confirm fullscreen header/intro text. |
| 178 | +- Exit fullscreen. |
| 179 | +- Confirm toggle label includes tool name. |
| 180 | +- Search DOM/text for visible generic labels: |
| 181 | + - `Header and Intro` |
| 182 | + - `Hide Header and Details` |
| 183 | + - `Show Header and Details` |
| 184 | + |
| 185 | +--- |
| 186 | + |
| 187 | +## Required Evidence |
| 188 | + |
| 189 | +Create: |
| 190 | + |
| 191 | +```txt |
| 192 | +tmp/pr_tool_fix_parallax_header_metadata_validation.json |
| 193 | +``` |
| 194 | + |
| 195 | +Include: |
| 196 | + |
| 197 | +- tool id |
| 198 | +- normal header text |
| 199 | +- normal intro text |
| 200 | +- fullscreen header text |
| 201 | +- fullscreen intro text |
| 202 | +- post-exit toggle text |
| 203 | +- generic labels found/not found |
| 204 | +- PASS/FAIL |
| 205 | + |
| 206 | +--- |
| 207 | + |
| 208 | +## Required Report |
| 209 | + |
| 210 | +Create: |
| 211 | + |
| 212 | +```txt |
| 213 | +docs/dev/reports/PR_tool_fix_parallax_header_metadata_report.md |
| 214 | +``` |
| 215 | + |
| 216 | +Include: |
| 217 | + |
| 218 | +- PASS/FAIL |
| 219 | +- changed files |
| 220 | +- metadata fields added/fixed |
| 221 | +- toggle label behavior |
| 222 | +- validation commands/results |
| 223 | +- remaining issues |
0 commit comments