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
{{ message }}
Repository navigation
Commit 821d54c
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: dev/docs_build/dev/ProjectInstructions/PROJECT_INSTRUCTIONS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,7 @@ When active guidance overlaps, use these canonical owner documents:
66
66
67
67
- Workflow and Product Owner testable completion: `dev/docs_build/dev/ProjectInstructions/addendums/pr_workflow.md`
68
68
- START / WORK / END lifecycle, branch gates, mandatory hard stops, and EOD main lock: `dev/docs_build/dev/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md`
69
-
- Repository directory ownership and restructure boundaries: `dev/docs_build/dev/ProjectInstructions/addendums/repository_directory_standard.md`
69
+
- Repository directory ownership, final root standard, final `src/` layer standard, final `dev/` workspace standard, and restructure boundaries: `dev/docs_build/dev/ProjectInstructions/addendums/repository_directory_standard.md`
70
70
- Page-level Playwright organization and completion coverage: `dev/docs_build/dev/ProjectInstructions/addendums/test_structure_standardization.md`
71
71
- API/environment model and `Browser -> API -> Database` rule: `dev/docs_build/dev/ProjectInstructions/addendums/environment_governance_model.md`
72
72
- Environment variable, URL, R2 prefix, and feature flag configuration: `dev/docs_build/dev/ProjectInstructions/addendums/environment_configuration_standards.md`
Copy file name to clipboardExpand all lines: dev/docs_build/dev/ProjectInstructions/addendums/repository_directory_standard.md
+38-4Lines changed: 38 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,57 @@ Owner: OWNER
5
5
6
6
## Purpose
7
7
8
-
Define the target repository directory ownership model before the development workspace restructure chain begins.
8
+
Define the target repository directory ownership model for the post-restructure repository.
9
9
10
10
This document is governance only. It does not move runtime, UI, API, tests, or production files by itself.
11
11
12
12
## Directory Ownership
13
13
14
-
- Repository root contains production/public product sections and standard repository configuration.
14
+
- Repository root contains production/public product sections and standard repository configuration only.
15
15
-`src/` contains deployable application code.
16
16
-`dev/` contains non-deployable build, test, bootstrap, governance, report, and local workspace items.
17
17
-`docs/` remains at root because it is production Docs & Help.
18
18
-`games/` remains at root because it is public game discovery.
19
19
-`toolbox/` remains at root because it is the Creator toolbox/workspace.
20
+
- Other public product roots such as `account/`, `admin/`, `legal/`, and `assets/` remain root-level product sections when present.
21
+
22
+
## Final Src Layer Standard
23
+
24
+
The final `src/` ownership model is:
25
+
26
+
-`src/web/` for browser-facing deployable application modules used by public pages, account/admin surfaces, and Creator tools.
27
+
-`src/api-runtime/` for deployable API/runtime service modules that back the shared Browser -> API -> Postgres/R2 contract.
28
+
-`src/runtime/` for deployable game, tool, engine, and shared runtime capabilities.
29
+
30
+
Transition rule:
31
+
32
+
- Existing top-level `src/advanced/`, `src/api/`, `src/dev-runtime/`, `src/engine/`, `src/shared/`, and `src/tools/` directories are legacy transition buckets until explicit migration PRs move them.
33
+
- Do not add new top-level `src/` layer names outside `src/web/`, `src/api-runtime/`, or `src/runtime/` without OWNER approval.
34
+
- Do not use team names in runtime source filenames.
20
35
21
36
## Development Workspace Paths
22
37
23
-
-`dev/docs_build/` owns active development governance, Project Instructions, PR workflow material, validation reports, and generated documentation-workspace artifacts.
38
+
-`dev/docs_build/` owns active development governance, Project Instructions, and PR workflow material.
39
+
-`dev/reports/` owns generated reports using flat filenames.
40
+
-`dev/tests/` owns non-deployable test suites.
41
+
-`dev/scripts/` owns development-only scripts and runners.
42
+
-`dev/config/` owns development-only runner and tooling configuration.
43
+
-`dev/workspace/artifacts/` owns generated non-report artifacts and ignored local temporary workspace output.
24
44
-`dev/archive/` owns historical development reference material that is not active governance.
25
45
-`dev/project-instructions/` is deprecated reference only when retained; it must point to `dev/docs_build/dev/ProjectInstructions/`.
26
-
- Root `docs_build/`, root `archive/`, and root `project-instructions/` are not active workspace locations after the governance workspace move.
46
+
- Root `docs_build/`, root `tests/`, root `archive/`, root `tmp/`, and root `project-instructions/` are not active workspace locations after the restructure.
47
+
- Root `tmp/` may remain ignored as legacy local scratch only; required Codex ZIPs and generated temporary artifacts belong under `dev/workspace/artifacts/tmp/`.
48
+
49
+
## Legacy Reference Exceptions
50
+
51
+
Path references to old root `docs_build/`, `tests/`, `archive/`, or `tmp/` locations are allowed only when they are:
52
+
53
+
- historical/reference content under `dev/archive/` or `dev/docs_build/dev/PR/reference/`
54
+
- explicit legacy exception notes in active governance
55
+
- ignore rules that keep obsolete local scratch from entering commits
56
+
- migration reports documenting the old path and its replacement
57
+
58
+
Active commands, templates, and Project Instructions must use the final `dev/`, `dev/reports/`, and `dev/workspace/artifacts/` paths.
27
59
28
60
## Creator Data Boundary
29
61
@@ -42,3 +74,5 @@ This document is governance only. It does not move runtime, UI, API, tests, or p
42
74
## PR Chain Boundary
43
75
44
76
The development workspace restructure must proceed through sequential scoped PRs. A PR may only move or update the paths named in its purpose.
77
+
78
+
Final path-governance PRs may document target paths and legacy exceptions, but they must not move deployable application code unless explicitly scoped.
| PASS | Final root directory standard documented | repository_directory_standard.md names product root, src, dev, docs, games, toolbox, and public product roots |
26
+
| PASS | Final src layer standard documented | src/web, src/api-runtime, and src/runtime documented with legacy transition buckets |
27
+
| PASS | Final dev workspace standard documented | dev/docs_build, dev/reports, dev/tests, dev/scripts, dev/config, dev/archive, and dev/workspace/artifacts documented |
28
+
| PASS | Old report root references absent from active target search | (no matches) |
29
+
| PASS | Old <projectfolder>/tmp ZIP reference absent from active target search | (no matches) |
| PASS | Finalize all Project Instructions and governance references to the new paths | Active governance references final dev/report/artifact paths and documents legacy exceptions. |
6
+
| PASS | Document final root directory standard | repository_directory_standard.md and README updated. |
7
+
| PASS | Document final src/ layer standard | src/web, src/api-runtime, src/runtime documented. Existing top-level src buckets are legacy transition only. |
8
+
| PASS | Document final dev/ workspace standard | dev ownership for docs_build, reports, tests, scripts, config, archive, workspace/artifacts documented. |
9
+
| PASS | Confirm no old docs_build/, tests/, archive/, or tmp/ path references remain unless documented as legacy exceptions | Old root paths are documented as legacy exceptions; active output/report refs use new paths. |
10
+
| PASS | No runtime/product/API/database changes | Protected diff check returned no files. |
0 commit comments