Skip to content

Commit 882eff8

Browse files
committed
OWNER 010 document Codex bootstrap architecture
1 parent 9e9f39b commit 882eff8

10 files changed

Lines changed: 553 additions & 286 deletions

dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Project Instructions Operating System
22

3-
Read `README.txt` first.
3+
Bootstrap entry point: request this `PROJECT_INSTRUCTIONS.md` file directly.
4+
5+
`README.txt` is supporting context loaded through this index; wrappers must not require users to specify it separately.
46

57
This file is the root index for the append-first Project Instructions operating system under `dev/build/ProjectInstructions/`.
68

@@ -10,10 +12,24 @@ This file is the root index for the append-first Project Instructions operating
1012

1113
Historical Project Instructions material outside this folder is deprecated reference material only and must not be used as an active source of governance.
1214

15+
## Required Bootstrap Entry
16+
17+
Only this file, `dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md`, is requested directly by the Codex Start-of-Day bootstrap.
18+
19+
All other active documents are loaded indirectly through references from this file.
20+
21+
Required indirect sources:
22+
- Project state: `dev/build/ProjectInstructions/PROJECT_STATE.md`
23+
- Repository folder placement SSoT: `dev/build/ProjectInstructions/addendums/canonical_repository_structure.md`
24+
- Codex bootstrap architecture: `dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md`
25+
- Team instructions and backlog: `dev/build/ProjectInstructions/team_assignments/` and `dev/build/ProjectInstructions/backlog/BACKLOG_MASTER.md`
26+
1327
## Purpose
1428

1529
The Project Instructions operating system provides additive governance for:
1630

31+
- Codex start-of-day bootstrap loading
32+
- project state ownership
1733
- backlog ownership
1834
- team assignments
1935
- multi-team branch and scope rules
@@ -42,6 +58,12 @@ Existing Project Instructions outside `dev/build/ProjectInstructions/` remain pr
4258
- Retained reference material belongs under the repository root `dev/archive/` tree, not under `dev/build/dev/`.
4359
- History snapshots belong under `dev/archive/legacy-docs-build/ProjectInstructions/history/`.
4460

61+
## Single Source Of Truth Files
62+
63+
- `PROJECT_INSTRUCTIONS.md` owns the active Project Instructions entry point, index, and referenced load graph.
64+
- `PROJECT_STATE.md` owns current repository/team state metadata used by bootstrap summaries.
65+
- `addendums/canonical_repository_structure.md` owns repository folder placement and file-placement rules.
66+
4567
## Recognized Project Reference Files
4668

4769
`dev/build/ProjectInstructions/addendums/project_reference_files.md` defines additional valid project instruction/reference files that must be included in future Project Instructions reviews when present in `ProjectInstructions.zip`, the active project instruction directory, or the root archive reference tree.
@@ -64,6 +86,7 @@ Existing Project Instructions outside `dev/build/ProjectInstructions/` remain pr
6486

6587
When active guidance overlaps, use these canonical owner documents:
6688

89+
- Codex Start-of-Day bootstrap architecture and loading rules: `dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md`
6790
- Workflow and Product Owner testable completion: `dev/build/ProjectInstructions/addendums/pr_workflow.md`
6891
- START / WORK / END lifecycle, branch gates, mandatory hard stops, and EOD main lock: `dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md`
6992
- Repository folder placement, directory ownership, final root standard, final `src/` layer standard, final `dev/` workspace standard, and restructure boundaries: `dev/build/ProjectInstructions/addendums/canonical_repository_structure.md`
@@ -93,6 +116,10 @@ Other active addendums may summarize these rules, but they must point back to th
93116

94117
`dev/build/ProjectInstructions/addendums/no_mock_repository_runtime_source.md` defines the Browser → API → Database product-data rule and mock repository technical debt boundary.
95118

119+
## Codex Bootstrap Governance
120+
121+
`dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md` defines Bootstrap Phrases, Bootstrap Responsibilities, Wrapper Responsibilities, Standard Bootstrap Report, loading rules, SSoT ownership, and the future wrapper direction for the phrase `Use Latest Project Instructions`.
122+
96123
## Standards
97124

98125
Active contract, model, and platform standards live under:
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Project State
2+
3+
Status: Active
4+
5+
Owner: OWNER
6+
7+
Version: 2026-06-27.PR_26179_OWNER_010
8+
9+
## Purpose
10+
11+
`PROJECT_STATE.md` is the single source of truth for current repository and team state metadata used by Codex Start-of-Day bootstrap summaries.
12+
13+
## Ownership
14+
15+
- `PROJECT_INSTRUCTIONS.md` owns the Project Instructions entry point and referenced load graph.
16+
- `PROJECT_STATE.md` owns current project state metadata.
17+
- `addendums/canonical_repository_structure.md` owns repository folder placement and file-placement rules.
18+
19+
## Current State Fields
20+
21+
Wrappers and Codex bootstrap summaries may report:
22+
23+
- Project State Version
24+
- Repository Version
25+
- Team
26+
- Branch
27+
- Worktree
28+
- Backlog Loaded
29+
- Additional Documents Loaded
30+
- Next Recommended PR
31+
32+
This file documents the state contract only. It does not implement wrapper behavior.

dev/build/ProjectInstructions/README.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Read this file first.
1+
Supporting context for `PROJECT_INSTRUCTIONS.md`.
2+
3+
Codex Start-of-Day wrappers request `PROJECT_INSTRUCTIONS.md` directly. This README is loaded indirectly through that entry point.
24

35
Folder purpose:
46
This folder is the only active Project Instructions source for Game Foundry Studio. It organizes active governance, backlog, team assignment, standards, deprecation, and history material under `dev/build/ProjectInstructions/`.
@@ -32,7 +34,7 @@ Do not rewrite history snapshots after creation unless the owner explicitly appr
3234

3335
READ THIS FIRST
3436

35-
1. Read `dev/build/ProjectInstructions/README.txt` before making changes.
37+
1. Use `dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md` as the only direct bootstrap entry point.
3638
2. Treat `dev/build/ProjectInstructions/` as the only active Project Instructions source.
3739
3. Historical Project Instructions files outside this folder are deprecated references only and must not be used as active sources.
3840
4. Team ownership must be respected.
@@ -49,6 +51,7 @@ Addendum index:
4951
- Documentation Ownership: dev/build/ProjectInstructions/addendums/documentation_ownership.md
5052
- Canonical Repository Structure: dev/build/ProjectInstructions/addendums/canonical_repository_structure.md
5153
- Repository Directory Standard (superseded pointer): dev/build/ProjectInstructions/addendums/repository_directory_standard.md
54+
- Codex Start-of-Day Bootstrap: dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md
5255
- Team Backlog, SOD, And EOD Standard: dev/build/ProjectInstructions/addendums/team_backlog_sod_eod_standard.md
5356
- Single Source and EOD Main Lock: dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md
5457
- Test Structure Standardization: dev/build/ProjectInstructions/addendums/test_structure_standardization.md

dev/build/ProjectInstructions/addendums/codex_project_instructions_startup.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Ensure Codex uses the current approved governance before making repository chang
66

77
## Startup Requirement
88

9-
Before performing work, Codex must review and use:
9+
Before performing work, Codex must request the latest Project Instructions through the single direct entry point:
1010

1111
```text
12-
dev/build/ProjectInstructions/
12+
dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md
1313
```
1414

15+
All other Project Instructions documents are loaded indirectly through references from `PROJECT_INSTRUCTIONS.md`.
16+
1517
Codex must use this as the only active source of truth for:
1618
- Governance rules
1719
- Repository standards
@@ -21,6 +23,12 @@ Codex must use this as the only active source of truth for:
2123
- Execution modes
2224
- Artifact requirements
2325

26+
The Codex Start-of-Day bootstrap architecture is defined in:
27+
28+
```text
29+
dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md
30+
```
31+
2432
## Branch Lifecycle Start Gate
2533

2634
Codex must follow the canonical lifecycle in:
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Codex Start-of-Day Bootstrap
2+
3+
Status: Approved
4+
5+
Owner: OWNER
6+
7+
## Purpose
8+
9+
Define the Codex Start-of-Day bootstrap architecture for loading the latest Project Instructions, project state, team context, and branch/worktree status before implementation begins.
10+
11+
This document is documentation and wrapper/bootstrap design only. It does not implement wrapper behavior.
12+
13+
## Bootstrap Phrase
14+
15+
A Bootstrap Phrase is a short user-facing phrase that asks the wrapper to resolve the latest Project Instructions and team state before launching Codex.
16+
17+
Examples:
18+
19+
- Owner Start of Day
20+
- Team Alpha Start of Day
21+
- Team Bravo Start of Day
22+
- Team Charlie Start of Day
23+
- Team Gamma Start of Day
24+
25+
Team name note:
26+
- `Team Alpha Start of Day` is accepted as a user phrase alias for the canonical Team Alfa lane.
27+
- Historical Team Gamma phrases may be understood for archived/historical context, but active assignment routing follows the current team registry.
28+
29+
## Bootstrap Responsibilities
30+
31+
The bootstrap loads:
32+
33+
- Latest Project Instructions SSoT
34+
- `PROJECT_STATE.md`
35+
- Canonical Repository Structure
36+
- Team instructions
37+
- Team backlog
38+
- Current team status
39+
- Current branch
40+
- Worktree status
41+
42+
The bootstrap must not create branches, commit files, move files, or run implementation work by itself.
43+
44+
## Wrapper Responsibilities
45+
46+
The wrapper performs:
47+
48+
- Branch verification
49+
- Worktree verification
50+
- Bootstrap loading
51+
- Version reporting
52+
- Start-of-day summary
53+
- Launch Codex with the resolved instruction set
54+
55+
The wrapper must not modify runtime code, production pages, or existing wrapper scripts as part of this architecture definition.
56+
57+
## Standard Bootstrap Report
58+
59+
```text
60+
Bootstrap
61+
----------
62+
Project Instructions Version:
63+
Project State Version:
64+
Repository Version:
65+
Team:
66+
Branch:
67+
Worktree:
68+
Backlog Loaded:
69+
Additional Documents Loaded:
70+
Next Recommended PR:
71+
```
72+
73+
## Loading Rules
74+
75+
Only `PROJECT_INSTRUCTIONS.md` is requested directly.
76+
77+
All other documents are loaded indirectly through references from `PROJECT_INSTRUCTIONS.md`.
78+
79+
`PROJECT_INSTRUCTIONS.md` is the only required entry point for Codex Start-of-Day bootstrap loading.
80+
81+
The bootstrap load graph begins at:
82+
83+
```text
84+
dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md
85+
```
86+
87+
## Single Source Of Truth
88+
89+
`PROJECT_INSTRUCTIONS.md` owns:
90+
91+
- Active Project Instructions entry point
92+
- Project Instructions index
93+
- Referenced load graph
94+
- Canonical governance owner links
95+
96+
`PROJECT_STATE.md` owns:
97+
98+
- Current project state metadata
99+
- Project State Version
100+
- Repository/team summary fields used by bootstrap reporting
101+
102+
`canonical_repository_structure.md` owns:
103+
104+
- Repository folder placement
105+
- Valid top-level folders
106+
- Valid dev workspace folders
107+
- File-placement rules
108+
- Invalid legacy path rules
109+
110+
## Future Direction
111+
112+
Future wrappers should understand:
113+
114+
```text
115+
Use Latest Project Instructions
116+
```
117+
118+
without requiring users to specify file paths.
119+
120+
When this phrase is used, the wrapper should resolve `PROJECT_INSTRUCTIONS.md`, follow its references, load current project state and team context, report versions, verify branch/worktree status, and launch Codex with the resolved instruction set.
121+
122+
## Validation
123+
124+
Bootstrap architecture changes are documentation-governance changes unless explicitly scoped otherwise.
125+
126+
Required validation for this design-only layer:
127+
128+
- Documentation review
129+
- `git diff --check`

0 commit comments

Comments
 (0)