Skip to content

Commit b334af9

Browse files
author
DavidQ
committed
Combine legacy reduction and documentation-system closeout into one low-PR pass
BUILD_PR_LEVEL_15_16_LEGACY_REDUCTION_AND_DOCUMENTATION_SYSTEM_COMBINED_CLOSEOUT & Normalize phase descriptions repo-wide and close the final Section-16 residue BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION
1 parent 851a1b1 commit b334af9

12 files changed

Lines changed: 221 additions & 22 deletions

docs/MASTER_ROADMAP_HIGH_LEVEL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -528,8 +528,8 @@
528528
## 13. 3D Capability Track (Phase 16)
529529

530530
### Phase 16 Description Alignment
531-
- [ ] phase-16 description updated in repo docs/index
532-
- [ ] phase-16 description kept separate from networking language
531+
- [x] phase-16 description updated in repo docs/index
532+
- [x] phase-16 description kept separate from networking language
533533

534534
### Prerequisite Samples
535535
- [ ] 3D Scene Boot Sample
@@ -593,7 +593,7 @@
593593
- [.] master roadmap committed and maintained
594594
- [ ] per-component roadmap slices added only when truly needed
595595
- [ ] structure normalization roadmap linked to future BUILD lanes
596-
- [ ] phase descriptions normalized repo-wide
596+
- [x] phase descriptions normalized repo-wide
597597
- [ ] naming policy documented
598598

599599
---

docs/dev/CODEX_COMMANDS.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
Create BUILD_PR_LEVEL_14_TESTS_VALIDATION_RESIDUE_ONLY and close remaining items only.
1+
MODEL: GPT-5.4
2+
REASONING: high
3+
4+
COMMAND:
5+
Create `BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION`.
6+
7+
Goal:
8+
Close the final remaining item:
9+
- phase descriptions normalized repo-wide
10+
11+
Required work:
12+
1. Find repo locations where phase descriptions are defined or repeated.
13+
2. Normalize them so they are consistent with the current roadmap, numbering, and phase structure.
14+
3. Touch only phase-description text and directly related references.
15+
4. Do not expand scope into unrelated documentation cleanup.
16+
5. Update roadmap status markers only.
17+
6. Report whether the item can now be truthfully marked complete.
18+
19+
Final packaging step is REQUIRED:
20+
- package ALL changed files into this exact repo-structured ZIP:
21+
`<project folder>/tmp/BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION.zip`
22+
23+
Hard rules:
24+
- smallest valid closeout
25+
- no unrelated repo changes
26+
- no missing ZIP

docs/dev/COMMIT_COMMENT.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
BUILD_PR_LEVEL_14_TESTS_VALIDATION_RESIDUE_ONLY
1+
Normalize phase descriptions repo-wide and close the final Section-16 residue
2+
BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# BUILD_PR_LEVEL_15_16_LEGACY_REDUCTION_AND_DOCUMENTATION_SYSTEM_COMBINED_CLOSEOUT Report
2+
3+
## Scope
4+
Docs-first combined closeout pass for:
5+
- Section 15 (`Legacy Reduction`)
6+
- Section 16 (`Documentation + Planning System`)
7+
8+
No engine/runtime/tool implementation files were changed.
9+
10+
## Section 15 Completion Evidence
11+
- `legacy inventory completed`
12+
- Evidence: `docs/dev/reports/cleanup_live_reference_inventory.txt`
13+
- `keep vs migrate vs future-delete decisions recorded`
14+
- Evidence: `docs/dev/reports/cleanup_keep_move_future_delete_matrix.md`
15+
- ``legacy class-retention policy marker` policy defined`
16+
- Evidence: `docs/dev/reports/classes_old_keep_policy_decision.md`
17+
- ``SpriteEditor_old_keep` policy defined`
18+
- Evidence: `docs/dev/reports/cleanup_keep_move_future_delete_matrix.md` (`docs/archive/tools/SpriteEditor_old_keep/` policy row)
19+
- `archived notes policy defined`
20+
- Evidence: `docs/dev/reports/archived_notes_policy_decision.md`
21+
- `roadmap for eventual legacy retirement defined`
22+
- Evidence: `docs/dev/reports/classes_old_keep_cleanup_recommendation.md`
23+
24+
## Section 16 Completion Evidence
25+
- `per-component roadmap slices added only when truly needed`
26+
- Evidence: active roadmap folder remains minimal (`docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md` + `docs/dev/roadmaps/README.md` only); no unnecessary per-component slices were introduced in this lane.
27+
- `structure normalization roadmap linked to future BUILD lanes`
28+
- Evidence: `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md` includes dependency-ordered future BUILD lanes and normalization lanes.
29+
30+
## Residue / Blockers
31+
- Remaining open item:
32+
- `phase descriptions normalized repo-wide`
33+
- Blocker:
34+
- Requires a dedicated, explicit wording-normalization pass across broad docs surfaces; not completed in this surgical closeout to avoid broad churn.
35+
36+
## Roadmap Edit Policy Check
37+
- Changes to `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md` were status-marker-only (`[ ]`, `[.]`, `[x]`) with no wording rewrite.
38+
39+
## Follow-Up Recommendation
40+
- One residue-only docs pass can close the remaining phase-description normalization item.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION Report
2+
3+
## Scope
4+
Phase-description text normalization only.
5+
6+
## Normalized Locations
7+
- `samples/index.html`
8+
- `Phase 06 - AI + World` -> `Phase 06 - AI + World Simulation`
9+
- `Phase 13 - Network Concepts, Latency and Simulation` -> `Phase 13 - Network Concepts, Latency & Simulation`
10+
- `Phase 16 - 3D Games` -> `Phase 16 - 3D Capability Track`
11+
- `samples/metadata/samples.index.metadata.json`
12+
- `Phase 13 - Network Concepts, Latency and Simulation` -> `Phase 13 - Network Concepts, Latency & Simulation`
13+
14+
## Related Roadmap Status Updates (Markers Only)
15+
- `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md`
16+
- `phase-16 description updated in repo docs/index` -> `[x]`
17+
- `phase-16 description kept separate from networking language` -> `[x]`
18+
- `phase descriptions normalized repo-wide` -> `[x]`
19+
- `docs/MASTER_ROADMAP_HIGH_LEVEL.md`
20+
- same three marker updates applied for mirrored roadmap consistency
21+
22+
## Validation Summary
23+
- Phase title consistency check passed for phase tracks surfaced in `samples/index.html` and metadata list entries.
24+
- Phase 16 description in `samples/index.html` is now 3D-specific and no longer generic "3D Games" wording.
25+
26+
## Completion Decision
27+
- The item `phase descriptions normalized repo-wide` can now be truthfully marked complete for active roadmap/index/metadata surfaces.
28+
- Historical archived docs and historical PR records were intentionally not rewritten.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
Residue closeout
1+
- Added final residue-only PR for repo-wide phase-description normalization
2+
- Intended to close the last remaining item in Sections 15/16
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
Only remaining items touched
1+
- phase-description text normalized repo-wide where needed
2+
- unrelated docs left untouched
3+
- roadmap updated by status markers only
4+
- final item can be truthfully marked complete or exact blockers are reported
5+
- output ZIP created at:
6+
<project folder>/tmp/BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION.zip

docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -515,8 +515,8 @@
515515
## 13. 3D Capability Track (Phase 16)
516516

517517
### Phase 16 Description Alignment
518-
- [ ] phase-16 description updated in repo docs/index
519-
- [ ] phase-16 description kept separate from networking language
518+
- [x] phase-16 description updated in repo docs/index
519+
- [x] phase-16 description kept separate from networking language
520520

521521
### Prerequisite Samples
522522
- [ ] 3D Scene Boot Sample
@@ -561,13 +561,13 @@
561561
---
562562

563563
## 15. Legacy Reduction
564-
- [.] legacy inventory completed
565-
- [.] keep vs migrate vs future-delete decisions recorded
566-
- [ ] `legacy class-retention policy marker` policy defined
567-
- [.] `SpriteEditor_old_keep` policy defined
568-
- [ ] archived notes policy defined
564+
- [x] legacy inventory completed
565+
- [x] keep vs migrate vs future-delete decisions recorded
566+
- [x] `legacy class-retention policy marker` policy defined
567+
- [x] `SpriteEditor_old_keep` policy defined
568+
- [x] archived notes policy defined
569569
- [x] imports pointing to legacy paths reduced
570-
- [.] roadmap for eventual legacy retirement defined
570+
- [x] roadmap for eventual legacy retirement defined
571571
- [x] `templates/` folder evaluated, relocated to `tools/templates/`, and root `templates/` removed after validation
572572

573573
---
@@ -578,9 +578,9 @@
578578
- [x] templates structure established
579579
- [x] roadmaps folder recognized as tracker space
580580
- [x] master roadmap committed and maintained
581-
- [ ] per-component roadmap slices added only when truly needed
582-
- [ ] structure normalization roadmap linked to future BUILD lanes
583-
- [ ] phase descriptions normalized repo-wide
581+
- [x] per-component roadmap slices added only when truly needed
582+
- [x] structure normalization roadmap linked to future BUILD lanes
583+
- [x] phase descriptions normalized repo-wide
584584
- [x] naming policy documented
585585

586586
---
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# BUILD_PR_LEVEL_15_16_LEGACY_REDUCTION_AND_DOCUMENTATION_SYSTEM_COMBINED_CLOSEOUT
2+
3+
## Purpose
4+
Bundle the remaining cleanup/documentation lanes into one combined pass to reduce PR count.
5+
6+
## Combined target lanes
7+
8+
### 15. Legacy Reduction
9+
- legacy inventory completed
10+
- keep vs migrate vs future-delete decisions recorded
11+
- `legacy class-retention policy marker` policy defined
12+
- `SpriteEditor_old_keep` policy defined
13+
- archived notes policy defined
14+
- roadmap for eventual legacy retirement defined
15+
16+
### 16. Documentation + Planning System
17+
- per-component roadmap slices added only when truly needed
18+
- structure normalization roadmap linked to future BUILD lanes
19+
- phase descriptions normalized repo-wide
20+
21+
## Strategy
22+
Treat these as one combined governance/cleanup lane:
23+
- legacy inventory + policy decisions
24+
- roadmap/planning documentation normalization
25+
- future-retirement guidance
26+
- only add per-component roadmap slices where clearly justified
27+
28+
## Combined scope
29+
30+
### A. Legacy reduction closeout
31+
Complete the remaining legacy inventory/policy work:
32+
- finish inventory truthfully
33+
- record keep vs migrate vs future-delete decisions
34+
- define class-retention marker policy
35+
- define archived-notes policy
36+
- finalize roadmap for eventual retirement
37+
38+
### B. Documentation/planning closeout
39+
Complete the remaining planning-system residue:
40+
- normalize phase descriptions repo-wide where still inconsistent
41+
- link structure normalization roadmap to future BUILD lanes
42+
- add per-component roadmap slices only where genuinely necessary
43+
- avoid gratuitous roadmap proliferation
44+
45+
### C. Low-PR rule
46+
This PR should close as many of the remaining lane items as truthfully possible in one pass.
47+
If anything remains open:
48+
- keep the residue very small
49+
- report exact blockers
50+
- aim for one final residue-only PR at most
51+
52+
## Desired outcome
53+
This PR should either:
54+
1. complete most or all of Sections 15 and 16 in one pass, or
55+
2. leave only a very small explicit residue list
56+
57+
## Roadmap handling
58+
- update status markers only
59+
- no roadmap text rewrite
60+
61+
## Validation requirements
62+
Codex must report:
63+
- which lane items were completed
64+
- any remaining residue
65+
- exact blockers for anything still open
66+
- whether one final follow-up PR can finish the combined cleanup/documentation lane
67+
68+
## Packaging
69+
`<project folder>/tmp/BUILD_PR_LEVEL_15_16_LEGACY_REDUCTION_AND_DOCUMENTATION_SYSTEM_COMBINED_CLOSEOUT.zip`
70+
71+
## Scope guard
72+
- docs-first PR bundle
73+
- Codex writes implementation
74+
- combine aggressively to reduce PR count
75+
- no unrelated repo changes
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION
2+
3+
## Purpose
4+
Close the final remaining item in Sections 15/16:
5+
6+
- phase descriptions normalized repo-wide
7+
8+
## Scope
9+
Normalize phase descriptions across the repo so they are consistent, accurate, and aligned with the current roadmap and phase structure.
10+
11+
## Rules
12+
- touch only phase-description text and directly related references
13+
- do not expand scope
14+
- do not rewrite unrelated docs
15+
- update roadmap status markers only
16+
17+
## Validation
18+
Codex must report:
19+
- where phase-description text was normalized
20+
- any remaining inconsistencies, if any
21+
- whether the item can now be truthfully marked complete
22+
23+
## Packaging
24+
`<project folder>/tmp/BUILD_PR_LEVEL_16_PHASE_DESCRIPTIONS_REPO_WIDE_NORMALIZATION.zip`

0 commit comments

Comments
 (0)