Skip to content

Commit 149247c

Browse files
author
DavidQ
committed
apply: shared 3D debug support layer
1 parent 2c5ec8c commit 149247c

26 files changed

Lines changed: 815 additions & 53 deletions
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 3D Sample Adapter Harness Notes
2+
3+
## Purpose
4+
Provide a low-risk validation path for shared 3D debug support without hard-coding a specific renderer into the shared layer.
5+
6+
## Harness Responsibilities
7+
- expose transform summaries
8+
- expose camera summaries
9+
- expose render stage summaries
10+
- expose collision/debug volume summaries
11+
- expose scene graph summaries
12+
13+
## Harness Rules
14+
- adapter remains project-local
15+
- shared 3D panels/providers stay generic
16+
- no renderer internals in shared layer

docs/dev/BIG_PICTURE_ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Do NOT change structure or wording.
8181

8282
- [.] Transform inspector
8383
- [x] BUILD_PR_DEBUG_SURFACES_3D_SUPPORT
84-
- [ ] APPLY_PR_DEBUG_SURFACES_3D_SUPPORT
84+
- [x] APPLY_PR_DEBUG_SURFACES_3D_SUPPORT
8585
- [ ] Camera debug panel
8686
- [ ] Render pipeline stages
8787
- [ ] Collision overlays

docs/dev/CODEX_COMMANDS.md

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

44
COMMAND:
5-
Create BUILD_PR_DEBUG_SURFACES_3D_SUPPORT
5+
Apply APPLY_PR_DEBUG_SURFACES_3D_SUPPORT
66

77
Requirements:
8-
- Docs-only
9-
- Include guardrails file
10-
- Update BIG_PICTURE_ROADMAP.md (brackets only)
11-
- Package to <project folder>/tmp/BUILD_PR_DEBUG_SURFACES_3D_SUPPORT_delta.zip
8+
- Execute the 3D support APPLY step only
9+
- Create summary-level shared 3D providers, shared 3D panels, and optional shared 3D presets
10+
- Keep renderer-specific adapters and scene extraction outside the shared layer
11+
- Preserve existing provider/panel/preset conventions
12+
- Do not add deep inspectors, renderer-specific implementations, or network support
13+
- Validate with a 3D sample or local adapter harness
14+
- Update BIG_PICTURE_ROADMAP.md by changing bracket states only
15+
- Include ROADMAP_GUARDRAILS.md unchanged
16+
- Package to <project folder>/tmp/APPLY_PR_DEBUG_SURFACES_3D_SUPPORT_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: build 3D support layer and define guardrails for apply readiness
1+
apply: shared 3D debug support layer

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-
APPLY_PR_DEBUG_SURFACES_3D_SUPPORT
2+
PLAN_PR_DEBUG_SURFACES_NETWORK_SUPPORT

docs/dev/ROADMAP_GUARDRAILS.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
# 🛡️ Roadmap Guardrails
22

3-
## RULE
4-
docs/dev/BIG_PICTURE_ROADMAP.md is a status tracker.
3+
## Purpose
4+
Prevent accidental corruption of BIG_PICTURE_ROADMAP.md by enforcing strict update rules.
55

6-
Allowed:
7-
- Change [ ] [.] [x] only
6+
## RULE: TRACKER FILE PROTECTION
7+
The file `docs/dev/BIG_PICTURE_ROADMAP.md` is a status tracker only.
88

9-
Forbidden:
10-
- Any wording/structure change
9+
### Allowed Changes
10+
- Change ONLY:
11+
- [ ][.][x]
1112

12-
## Validation
13+
### Forbidden Changes
14+
- Adding/removing sections
15+
- Rewriting text
16+
- Reordering items
17+
- Renaming tracks
18+
- Collapsing or expanding content
19+
20+
## VALIDATION CHECK
21+
Any change to BIG_PICTURE_ROADMAP.md must pass:
1322
- Headings unchanged
14-
- Only bracket diffs
23+
- No text modified outside brackets
24+
- Only bracket states updated
25+
26+
## CODEX RULE
27+
Codex must treat this file as immutable structure and perform surgical edits only.
Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
Created docs-only BUILD bundle for `BUILD_PR_DEBUG_SURFACES_3D_SUPPORT`.
1+
Created APPLY bundle for shared 3D debug support.
22

33
Included:
4-
- refreshed BUILD doc for 3D support contracts
5-
- new dedicated guardrails file
6-
- bracket-only roadmap state update
7-
- refreshed reports and packaging metadata
4+
- apply PR doc
5+
- codex command
6+
- roadmap guardrails
7+
- updated BIG_PICTURE_ROADMAP.md (brackets only)
8+
- 3D sample adapter harness notes
9+
- reports
810

9-
Scope controls maintained:
10-
- docs-only
11-
- no implementation code changes
12-
- renderer-specific/deep-inspector/network scope excluded
11+
Primary intent:
12+
- add summary-level, renderer-agnostic shared 3D support
13+
- keep adapters local

docs/dev/reports/file_tree.txt

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
BUILD_PR_DEBUG_SURFACES_3D_SUPPORT_delta.zip
2-
- docs/pr/BUILD_PR_DEBUG_SURFACES_3D_SUPPORT.md
3-
- docs/pr/BUILD_PR_DEBUG_SURFACES_3D_SUPPORT_GUARDRAILS.md
4-
- docs/dev/codex_commands.md
5-
- docs/dev/commit_comment.txt
6-
- docs/dev/BIG_PICTURE_ROADMAP.md
7-
- docs/dev/reports/change_summary.txt
8-
- docs/dev/reports/validation_checklist.txt
9-
- docs/dev/reports/file_tree.txt
1+
APPLY_PR_DEBUG_SURFACES_3D_SUPPORT_delta/
2+
└── docs/
3+
├── dev/
4+
│ ├── BIG_PICTURE_ROADMAP.md
5+
│ ├── ROADMAP_GUARDRAILS.md
6+
│ ├── codex_commands.md
7+
│ ├── commit_comment.txt
8+
│ ├── next_command.txt
9+
│ ├── 3D_SAMPLE_ADAPTER_HARNESS.md
10+
│ └── reports/
11+
│ ├── change_summary.txt
12+
│ ├── validation_checklist.txt
13+
│ └── file_tree.txt
14+
└── pr/
15+
└── APPLY_PR_DEBUG_SURFACES_3D_SUPPORT.md
Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
Validation Checklist
22

3-
[x] BUILD bundle is docs-only
4-
[x] Guardrails file is included
5-
[x] One PR purpose only (3D support BUILD)
6-
[x] Shared 3D panel inventory is present
7-
[x] Shared 3D provider inventory is present
8-
[x] Optional 3D presets are present
9-
[x] Adapter boundaries are explicit
10-
[x] Renderer-specific implementation scope excluded
11-
[x] Deep inspector scope excluded
12-
[x] Network scope excluded
13-
[x] BIG_PICTURE_ROADMAP.md updated by bracket changes only
14-
[x] Delta ZIP contains only BUILD-relevant docs
3+
[ ] Shared 3D providers created
4+
[ ] Shared 3D panels consume provider data only
5+
[ ] Optional shared 3D presets created
6+
[ ] Renderer-specific adapters remain local
7+
[ ] No deep inspectors added
8+
[ ] No renderer-specific logic added to shared layer
9+
[ ] BIG_PICTURE_ROADMAP.md changed by brackets only
10+
[ ] 3D sample/adapters validate successfully
Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,51 @@
11
# APPLY_PR_DEBUG_SURFACES_3D_SUPPORT
22

3-
## Steps
4-
1. Create shared 3D providers (summary)
5-
2. Create panels consuming providers
6-
3. Register optional 3D presets
7-
4. Keep adapters local to project
8-
5. Validate with a 3D sample/adapters
3+
## Purpose
4+
5+
Apply the approved 3D support plan by creating the first shared 3D panels, providers, and optional presets for the debug surfaces platform.
6+
7+
## Apply Scope
8+
9+
### Create Shared 3D Providers
10+
- `transformSummary`
11+
- `cameraSummary`
12+
- `renderStageSummary`
13+
- `collisionSummary`
14+
- `sceneGraphSummary`
15+
16+
### Create Shared 3D Panels
17+
- `3d.transform`
18+
- `3d.camera`
19+
- `3d.renderStages`
20+
- `3d.collision`
21+
- `3d.sceneGraph`
22+
23+
### Create Optional Shared 3D Presets
24+
- `preset.3d.inspect`
25+
- `preset.3d.render`
26+
- `preset.3d.camera`
27+
28+
### Keep Local
29+
- renderer-specific adapters
30+
- scene-specific extraction
31+
- project-specific debug visuals
32+
- engine-specific stage mappings
33+
34+
## Execution Order
35+
36+
1. Create summary-level 3D providers
37+
2. Create shared 3D panels consuming providers only
38+
3. Create optional shared 3D presets
39+
4. Add registration entry points
40+
5. Wire a sample adapter harness or 3D-capable sample integration
41+
6. Validate renderer-agnostic behavior and adapter boundaries
942

1043
## Rules
11-
- Use public APIs only
44+
45+
- Keep adoption opt-in
46+
- Preserve existing provider/panel/preset conventions
47+
- Shared layer must stay renderer-agnostic
48+
- Panels must consume provider data only
49+
- No deep inspectors in this PR
1250
- No renderer-specific logic in shared layer
51+
- No network support in this PR

0 commit comments

Comments
 (0)