You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Project Instructions Operating System
2
2
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.
4
6
5
7
This file is the root index for the append-first Project Instructions operating system under `dev/build/ProjectInstructions/`.
6
8
@@ -10,10 +12,24 @@ This file is the root index for the append-first Project Instructions operating
10
12
11
13
Historical Project Instructions material outside this folder is deprecated reference material only and must not be used as an active source of governance.
12
14
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.
- Retained reference material belongs under the repository root `dev/archive/` tree, not under `dev/build/dev/`.
43
59
- History snapshots belong under `dev/archive/legacy-docs-build/ProjectInstructions/history/`.
44
60
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
+
45
67
## Recognized Project Reference Files
46
68
47
69
`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.
When active guidance overlaps, use these canonical owner documents:
66
88
89
+
- Codex Start-of-Day bootstrap architecture and loading rules: `dev/build/ProjectInstructions/addendums/codex_start_of_day_bootstrap.md`
67
90
- Workflow and Product Owner testable completion: `dev/build/ProjectInstructions/addendums/pr_workflow.md`
68
91
- START / WORK / END lifecycle, branch gates, mandatory hard stops, and EOD main lock: `dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md`
69
92
- 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
93
116
94
117
`dev/build/ProjectInstructions/addendums/no_mock_repository_runtime_source.md` defines the Browser → API → Database product-data rule and mock repository technical debt boundary.
95
118
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
+
96
123
## Standards
97
124
98
125
Active contract, model, and platform standards live under:
Copy file name to clipboardExpand all lines: dev/build/ProjectInstructions/README.txt
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff 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.
2
4
3
5
Folder purpose:
4
6
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
32
34
33
35
READ THIS FIRST
34
36
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.
36
38
2. Treat `dev/build/ProjectInstructions/` as the only active Project Instructions source.
37
39
3. Historical Project Instructions files outside this folder are deprecated references only and must not be used as active sources.
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.
- 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.
0 commit comments