Skip to content

Commit 66c84d9

Browse files
author
DavidQ
committed
docs: build debug surfaces promotion extraction plan
1 parent 8a47ee5 commit 66c84d9

10 files changed

Lines changed: 219 additions & 184 deletions

docs/dev/CODEX_COMMANDS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ MODEL: GPT-5.4-codex
22
REASONING: high
33

44
COMMAND:
5-
Create PLAN_PR_DEBUG_SURFACES_PROMOTION
5+
Create BUILD_PR_DEBUG_SURFACES_PROMOTION
66

77
Requirements:
88
- Follow PLAN_PR -> BUILD_PR -> APPLY_PR
99
- Docs-first only
1010
- One PR per purpose
11-
- Minimize engine-core changes
12-
- Promote proven debug systems out of tools/dev
13-
- Define target ownership across engine-core, engine-debug, and project/sample/tool layers
14-
- Include target folder structure, migration phases, validation strategy, risk controls, and rollout notes
11+
- Extraction/relocation only; no feature expansion
12+
- Build authoritative target structure for engine-core vs engine-debug vs project-owned integrations
13+
- Include ownership matrix, ordered migration steps, validation goals, rollback strategy, and rollout notes
1514
- Keep sample-specific panels/providers/commands outside shared layers
15+
- Preserve `MultiSystemDemoScene.js` as the proving integration
1616
- Write outputs under docs/pr and docs/dev/reports
1717
- Put codex command and commit comment under docs/dev
18-
- Package to <project folder>/tmp/PLAN_PR_DEBUG_SURFACES_PROMOTION_delta.zip
18+
- Package to <project folder>/tmp/BUILD_PR_DEBUG_SURFACES_PROMOTION_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
docs: plan debug surfaces promotion from tools/dev to engine-debug with minimal engine-core contracts
1+
docs: build debug surfaces promotion extraction plan with authoritative ownership and migration rules

docs/dev/NEXT_COMMAND.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
Next:
2-
BUILD_PR_DEBUG_SURFACES_PROMOTION
2+
APPLY_PR_DEBUG_SURFACES_PROMOTION

docs/dev/RULES_OF_ENGAGEMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This file is the canonical workflow and rules document for active repo operation
2323
- Planning/docs bundle defines scope and acceptance.
2424
- Implementation applies approved scope only.
2525
- Active execution control files are in `docs/dev/`.
26-
- Update docs/dev/BIG_PICTURE_ROADMAP.md when needed [ ] to [.] to [x].
26+
- Update docs/dev/BIG_PICTURE_ROADMAP.md when needed [ ] Todo to [.] inprogress to [x] complete.
2727

2828
## Active Dev Controls
2929
- `docs/dev/codex_commands.md`

docs/dev/reports/change_summary.txt

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
PLAN_PR_DEBUG_SURFACES_PROMOTION change summary
1+
BUILD_PR_DEBUG_SURFACES_PROMOTION change summary
22

33
Summary
4-
- Created docs-first planning bundle for debug surfaces promotion.
5-
- Kept scope to one PR purpose: promotion planning only.
6-
- Defined ownership across engine-core, engine-debug, and project/sample/tool layers.
4+
- Produced a docs-first BUILD bundle for debug surfaces promotion.
5+
- Kept scope to extraction/relocation planning only (no feature expansion).
6+
- Locked authoritative ownership across engine-core, engine-debug, and project/sample/tool layers.
77

8-
What this plan defines
9-
- target folder structure for promoted debug surfaces
10-
- migration phases from ownership lock through stabilization
11-
- validation strategy for contracts, behavior, regressions, and safety
12-
- risk controls and rollout notes
13-
- explicit rule that sample-specific panels/providers/commands stay outside shared layers
8+
Included
9+
- authoritative target structure
10+
- ownership matrix
11+
- ordered migration steps
12+
- validation goals
13+
- rollback strategy
14+
- rollout notes
15+
- codex command and commit comment
16+
- report files
1417

15-
Key constraints preserved
16-
- no implementation migration in this PR
17-
- minimize engine-core changes
18-
- integration reference remains MultiSystemDemoScene.js
18+
Boundary outcomes
19+
- sample-specific panels/providers/commands remain outside shared layers
20+
- `MultiSystemDemoScene.js` preserved as proving integration
21+
- engine-core remains minimal and contract-only
1922

20-
Files in this bundle
23+
Outputs
2124
- docs/pr/PLAN_PR_DEBUG_SURFACES_PROMOTION.md
25+
- docs/pr/BUILD_PR_DEBUG_SURFACES_PROMOTION.md
26+
- docs/pr/APPLY_PR_DEBUG_SURFACES_PROMOTION.md
2227
- docs/dev/codex_commands.md
2328
- docs/dev/commit_comment.txt
2429
- docs/dev/reports/change_summary.txt
2530
- docs/dev/reports/validation_checklist.txt
2631
- docs/dev/reports/file_tree.txt
27-
28-
Next recommended command
29-
- BUILD_PR_DEBUG_SURFACES_PROMOTION

docs/dev/reports/file_tree.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
HTML-JavaScript-Gaming/
22
|-- docs/
33
| |-- pr/
4-
| | `-- PLAN_PR_DEBUG_SURFACES_PROMOTION.md
4+
| | |-- PLAN_PR_DEBUG_SURFACES_PROMOTION.md
5+
| | |-- BUILD_PR_DEBUG_SURFACES_PROMOTION.md
6+
| | `-- APPLY_PR_DEBUG_SURFACES_PROMOTION.md
57
| `-- dev/
68
| |-- codex_commands.md
79
| |-- commit_comment.txt
@@ -10,4 +12,4 @@ HTML-JavaScript-Gaming/
1012
| |-- validation_checklist.txt
1113
| `-- file_tree.txt
1214
`-- tmp/
13-
`-- PLAN_PR_DEBUG_SURFACES_PROMOTION_delta.zip
15+
`-- BUILD_PR_DEBUG_SURFACES_PROMOTION_delta.zip
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
PLAN_PR_DEBUG_SURFACES_PROMOTION validation checklist
1+
BUILD_PR_DEBUG_SURFACES_PROMOTION validation checklist
22

33
Workflow
4-
- [done] Followed PLAN_PR -> BUILD_PR -> APPLY_PR structure
4+
- [done] PLAN_PR -> BUILD_PR -> APPLY_PR structure preserved
55
- [done] Docs-first only
66
- [done] One PR per purpose
77

88
Scope
9-
- [done] Plan focuses on debug surfaces promotion only
10-
- [done] No engine-core implementation changes in this PR
11-
- [done] Integration reference documented: MultiSystemDemoScene.js
9+
- [done] Extraction/relocation only (no feature expansion)
10+
- [done] Engine-core changes minimized by contract-only ownership model
11+
- [done] Integration proving reference preserved: MultiSystemDemoScene.js
1212

13-
Plan Quality
14-
- [done] Ownership model defined for engine-core, engine-debug, project/sample/tool layers
15-
- [done] Target folder structure documented
16-
- [done] Migration phases documented
17-
- [done] Validation strategy documented
18-
- [done] Risk controls documented
13+
Build Content
14+
- [done] Authoritative target structure documented
15+
- [done] Ownership matrix documented
16+
- [done] Ordered migration steps documented
17+
- [done] Validation goals documented
18+
- [done] Rollback strategy documented
1919
- [done] Rollout notes documented
2020
- [done] Sample-specific panels/providers/commands explicitly kept outside shared layers
2121

22-
Artifacts
23-
- [done] Plan doc under docs/pr
22+
Outputs
23+
- [done] Docs under docs/pr
24+
- [done] Reports under docs/dev/reports
2425
- [done] Codex command under docs/dev
2526
- [done] Commit comment under docs/dev
26-
- [done] Reports under docs/dev/reports
27-
- [done] Delta zip generated at <project folder>/tmp/PLAN_PR_DEBUG_SURFACES_PROMOTION_delta.zip
27+
- [done] Delta zip generated at <project folder>/tmp/BUILD_PR_DEBUG_SURFACES_PROMOTION_delta.zip
Lines changed: 31 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,35 @@
11
# APPLY_PR_DEBUG_SURFACES_PROMOTION
22

3-
## Purpose
4-
5-
Apply the approved promotion plan by moving the proven debug-surface stack into a reusable `engine-debug` layer, while moving only minimal contracts/hooks into engine core.
3+
## Objective
4+
Apply the approved extraction/relocation plan for debug surfaces with no feature expansion and minimal engine-core changes.
65

76
## Apply Scope
8-
9-
### Promote to `engine-debug`
10-
- console host
11-
- overlay host
12-
- panel registry
13-
- provider registry/plumbing
14-
- operator command wiring
15-
- persistence
16-
- debug bootstrap/composition
17-
18-
### Promote to `engine-core`
19-
- debug interfaces
20-
- registration contracts
21-
- lifecycle hooks
22-
- environment/debug gating hooks
23-
24-
### Keep Project-Owned
25-
- sample-specific commands
26-
- sample-specific panels
27-
- sample-specific providers
28-
- scene wiring
29-
- tool-specific adapters
30-
31-
## Apply Rules
32-
33-
- no UI policy in engine core
34-
- no sample panel migration into shared layers
35-
- no direct console-to-panel coupling
36-
- preserve public API boundaries
37-
- keep provider flow read-only
38-
- validate against existing demo integration
39-
40-
## Exit Criteria
41-
42-
- shared debug implementation no longer lives in `tools/dev`
43-
- engine-debug contains the reusable platform
44-
- engine-core contains only minimal contracts/hooks
45-
- sample integration still works with minimal wiring change
7+
- relocate proven reusable debug systems into `engine/debug`
8+
- keep engine-core changes limited to debug contracts/hooks
9+
- preserve local ownership for sample-specific panels/providers/commands
10+
- preserve `MultiSystemDemoScene.js` as proving integration
11+
12+
## Guardrails
13+
- no feature expansion
14+
- no engine-core UI behavior ownership
15+
- no private console-overlay coupling
16+
- no promotion of sample-specific artifacts into shared layers
17+
18+
## Apply Sequence
19+
1. core contracts/hooks extraction
20+
2. console relocation
21+
3. overlay/registry/persistence relocation
22+
4. provider plumbing relocation
23+
5. bootstrap integration
24+
6. sample proving rewire
25+
7. parity + boundary validation
26+
27+
## Apply Validation
28+
- command/control and telemetry boundaries remain intact
29+
- overlay operator commands use public APIs only
30+
- registry remains runtime source of truth
31+
- provider and persistence behaviors remain stable
32+
- no unrelated files or systems changed
33+
34+
## Expected Outcome
35+
Debug surfaces are promoted out of `tools/dev` into shared `engine/debug` structure while engine-core remains minimal and local sample integrations stay local.
Lines changed: 77 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,97 @@
11
# BUILD_PR_DEBUG_SURFACES_PROMOTION
22

3-
## Purpose
3+
## Objective
4+
Create an authoritative docs-only BUILD bundle for extraction/relocation of proven debug surfaces from `tools/dev` into shared layers, with no feature expansion.
45

5-
Turn the promotion plan into a docs-only extraction bundle that is ready for Codex implementation.
6+
## Workflow
7+
PLAN_PR -> BUILD_PR -> APPLY_PR
68

7-
## Build Scope
9+
## Build Constraints
10+
- docs-first only
11+
- one PR purpose only
12+
- extraction/relocation only
13+
- no feature expansion
14+
- minimize engine-core changes
15+
- preserve `MultiSystemDemoScene.js` as proving integration
816

9-
Produce docs that define:
17+
## Authoritative Target Structure
18+
```text
19+
engine/
20+
core/
21+
debug/
22+
DebugSurfaceContracts.js
23+
DebugRegistrationHooks.js
24+
DebugEnvironmentGate.js
25+
debug/
26+
console/
27+
DevConsoleHost.js
28+
DevConsoleCommandBridge.js
29+
overlay/
30+
DebugOverlayHost.js
31+
OverlayPanelRegistry.js
32+
OverlayPersistenceAdapter.js
33+
providers/
34+
OverlayProviderRegistry.js
35+
bootstrap/
36+
DebugSurfacesBootstrap.js
1037
11-
- final target folder structure
12-
- exact ownership mapping
13-
- migration sequence
14-
- implementation boundaries
15-
- validation and rollback strategy
38+
project|sample|tool/
39+
debug/
40+
panels/ (local only)
41+
providers/ (local only)
42+
commands/ (local only)
43+
```
1644

17-
## Required Deliverables
45+
## Ownership Matrix
46+
| Capability | Engine Core | Engine Debug | Project/Sample/Tool |
47+
|---|---|---|---|
48+
| Debug contracts/hooks | Owns | Consumes | Consumes |
49+
| Console host runtime | No | Owns | Integrates |
50+
| Overlay host runtime | No | Owns | Integrates |
51+
| Panel registry | No | Owns | Extends via public registration |
52+
| Provider registry/plumbing | No | Owns | Extends via local providers |
53+
| Operator command wiring | No | Owns | May register local commands |
54+
| Persistence adapter boundary | No | Owns | May provide local storage key/config |
55+
| Sample-specific panels/providers/commands | No | No | Owns |
1856

19-
- ownership matrix
20-
- target tree
21-
- migration checklist
22-
- validation checklist
23-
- change summary
24-
- Codex command
25-
- commit comment
26-
- next command
57+
## Ordered Migration Steps
58+
1. Freeze ownership boundaries and no-go rules.
59+
2. Extract minimal core contracts/hooks into `engine/core/debug`.
60+
3. Relocate console host/bridge to `engine/debug/console`.
61+
4. Relocate overlay host/registry/persistence adapter to `engine/debug/overlay`.
62+
5. Relocate provider registry/plumbing to `engine/debug/providers`.
63+
6. Add shared bootstrap/composition in `engine/debug/bootstrap`.
64+
7. Rewire `MultiSystemDemoScene.js` through public bootstrap/registration APIs.
65+
8. Validate parity and boundary compliance.
2766

28-
## Build Rules
67+
## Validation Goals
68+
- no feature expansion introduced
69+
- console commands still function through public command registry
70+
- overlay still renders deterministically
71+
- provider reads remain read-only
72+
- panel persistence behavior remains stable
73+
- sample-specific artifacts remain outside shared layers
74+
- engine-core remains contract-only
75+
- `MultiSystemDemoScene.js` continues as proving integration
2976

30-
- one PR purpose only
31-
- docs-first only
32-
- no direct runtime implementation in this bundle
33-
- keep engine-core changes minimal
34-
- assume `engine-debug` is the primary target
35-
- preserve sample-level proving path through `MultiSystemDemoScene.js`
77+
## Rollback Strategy
78+
If migration is unstable:
79+
1. keep extracted core contracts/hooks unchanged
80+
2. revert relocation stages in reverse order (bootstrap -> providers -> overlay -> console)
81+
3. restore prior sample wiring
82+
4. re-run parity checks before retry
3683

37-
## Expected Build Output
84+
## Rollout Notes
85+
- BUILD bundle remains docs-only and implementation-ready
86+
- APPLY should execute incremental relocation with validation after each stage
87+
- stop and split scope if migration requires non-minimal core changes
3888

89+
## Deliverables
3990
- `docs/pr/PLAN_PR_DEBUG_SURFACES_PROMOTION.md`
4091
- `docs/pr/BUILD_PR_DEBUG_SURFACES_PROMOTION.md`
4192
- `docs/pr/APPLY_PR_DEBUG_SURFACES_PROMOTION.md`
4293
- `docs/dev/codex_commands.md`
4394
- `docs/dev/commit_comment.txt`
44-
- `docs/dev/next_command.txt`
4595
- `docs/dev/reports/change_summary.txt`
4696
- `docs/dev/reports/validation_checklist.txt`
4797
- `docs/dev/reports/file_tree.txt`

0 commit comments

Comments
 (0)