Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
8 changes: 5 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ NEXT_COMMAND.txt
node_modules/
tests/results/
tests/results/**
tmp/test-results/
tmp/test-results/**
dev/workspace/artifacts/tmp/
dev/workspace/artifacts/tmp/**
dev/workspace/artifacts/tmp/test-results/
dev/workspace/artifacts/tmp/test-results/**
tmp/
scripts/untracked/
projects/
Expand Down Expand Up @@ -47,4 +49,4 @@ docs/dev/reports/playwright_v8_coverage_report.txt

# Game Foundry Studio project files
assets/*.gfsp
docs_build/dev/ProjectInstructions.zip
dev/docs_build/dev/ProjectInstructions.zip
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ This repository follows a docs-first game/runtime model, combining a stable engi
## ▶️ Start Here

1. Review the repo model in [docs/README.md](docs/README.md)
2. Explore the roadmap in [docs_build/dev/roadmaps/MASTER_ROADMAP_ENGINE.md](docs_build/dev/roadmaps/MASTER_ROADMAP_ENGINE.md)
3. Browse archived reference samples from [archive/v1-v2/samples/index.html](archive/v1-v2/samples/index.html)
2. Explore active development governance in [dev/docs_build/dev/ProjectInstructions/](dev/docs_build/dev/ProjectInstructions/)
3. Browse archived reference samples from [dev/archive/v1-v2/samples/index.html](dev/archive/v1-v2/samples/index.html)
4. Explore tools under [toolbox/](toolbox/)
5. Review engine and architecture boundaries in [docs/architecture/](docs/architecture/)
6. Follow the workflow in [docs_build/dev/](docs_build/dev/) and [docs_build/pr/](docs_build/pr/)
6. Follow the workflow in [dev/docs_build/dev/](dev/docs_build/dev/) and [dev/docs_build/dev/PR/](dev/docs_build/dev/PR/)

---

Expand Down Expand Up @@ -105,18 +105,18 @@ PLAN_PR → BUILD_PR → APPLY_PR
- One PR per purpose
- Small, surgical changes
- Docs-first implementation planning
- Delta ZIP outputs stored under `<project folder>/tmp/`
- Delta ZIP outputs stored under `<project folder>/dev/workspace/artifacts/tmp/`

---

## 📚 Documentation Map

- [docs/README.md](docs/README.md) → top-level documentation index
- [docs/architecture/](docs/architecture/) → durable architecture and boundary contracts
- [docs_build/pr/](docs_build/pr/) → preserved PR history and architecture evolution
- [docs_build/dev/](docs_build/dev/) → active workflow controls and implementation planning
- [docs_build/dev/reports/](docs_build/dev/reports/) → active report artifacts
- [docs_build/archive/](docs_build/archive/) → archived dev-ops notes and generated reports
- [dev/docs_build/dev/PR/](dev/docs_build/dev/PR/) → preserved PR history and architecture evolution
- [dev/docs_build/dev/](dev/docs_build/dev/) → active workflow controls and implementation planning
- [dev/reports/](dev/reports/) → active report artifacts
- [dev/archive/](dev/archive/) → archived dev-ops notes and generated reports

---

Expand Down
4 changes: 3 additions & 1 deletion dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ This folder is the destination shell for non-deployable development workspace ma

## Governance Workspace

- `dev/docs_build/` owns active development governance, PR workflow material, and generated reports.
- `dev/docs_build/` owns active development governance and PR workflow material.
- `dev/reports/` owns generated reports.
- `dev/workspace/artifacts/` owns generated non-report artifacts and local temporary workspace output.
- `dev/archive/` owns historical development reference material.
- `dev/project-instructions/` is deprecated reference only; active Project Instructions live under `dev/docs_build/dev/ProjectInstructions/`.

Expand Down
10 changes: 5 additions & 5 deletions dev/config/playwright.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ const repoPath = (...segments) => path.join(repoRoot, ...segments);

module.exports = {
timeout: 120000,
outputDir: repoPath("tmp", "test-results"),
outputDir: repoPath("dev", "workspace", "artifacts", "tmp", "test-results"),
projects: [
{
name: "ui",
testDir: repoPath("dev", "tests", "ui"),
outputDir: repoPath("tmp", "test-results", "artifacts")
outputDir: repoPath("dev", "workspace", "artifacts", "tmp", "test-results", "artifacts")
},
{
name: "playwright",
testDir: repoPath("dev", "tests", "playwright"),
outputDir: repoPath("tmp", "test-results", "artifacts")
outputDir: repoPath("dev", "workspace", "artifacts", "tmp", "test-results", "artifacts")
}
],
reporter: [
["list"],
["html", { outputFolder: repoPath("tmp", "test-results", "report"), open: "always" }],
["json", { outputFile: repoPath("tmp", "test-results", "playwright-results.json") }]
["html", { outputFolder: repoPath("dev", "workspace", "artifacts", "tmp", "test-results", "report"), open: "always" }],
["json", { outputFile: repoPath("dev", "workspace", "artifacts", "tmp", "test-results", "playwright-results.json") }]
],
use: {
headless: false,
Expand Down
2 changes: 1 addition & 1 deletion dev/docs_build/dev/PR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This folder owns reusable PR workflow material and historical PR reference docum
- `reference/` contains historical or reference PR documents.

Reusable PR templates must not live outside `dev/docs_build/dev/PR/templates/`.
Generated PR reports must live under `dev/docs_build/dev/reports/`.
Generated PR reports must live under `dev/reports/`.
Permanent governance must live under `dev/docs_build/dev/ProjectInstructions/`.

## Rules
Expand Down
18 changes: 9 additions & 9 deletions dev/docs_build/dev/PR/reference/OWNER_007_BUILD_PR.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This `dev/docs_build/dev/pr/BUILD_PR.md`, `dev/docs_build/dev/pr/PLAN_PR.md`, an
- Remove stale one-off PR/restart files from `dev/docs_build/dev/` root.
- Move PR-specific docs from `dev/docs_build/dev/` root into `dev/docs_build/dev/pr/`.
- Move active governance/contract docs from `dev/docs_build/dev/` root into `dev/docs_build/dev/ProjectInstructions/addendums/`.
- Move audit outputs from `dev/docs_build/dev/` root into `dev/docs_build/dev/reports/audits/`.
- Move audit outputs from `dev/docs_build/dev/` root into `dev/reports/audits/`.
- Delete stale one-off bundle metadata from `dev/docs_build/dev/` root.
- Add Tool MVP Stacked PR Standard under `dev/docs_build/dev/ProjectInstructions/`.
- Update PR planning/template and report requirements for tool MVP PRs.
Expand All @@ -28,7 +28,7 @@ This `dev/docs_build/dev/pr/BUILD_PR.md`, `dev/docs_build/dev/pr/PLAN_PR.md`, an
- Keep `dev/project-instructions/` out of this PR except for a tiny deprecated pointer.
- Update active team start/governance docs to reference only `dev/docs_build/dev/ProjectInstructions/`.
- Add EOD main lock, next-day reset governance, and canonical START / WORK / END branch lifecycle rules.
- Add required reports under `dev/docs_build/dev/reports/`.
- Add required reports under `dev/reports/`.

## Exact Targets

Expand All @@ -43,7 +43,7 @@ This `dev/docs_build/dev/pr/BUILD_PR.md`, `dev/docs_build/dev/pr/PLAN_PR.md`, an
- `dev/docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md`
- `dev/docs_build/dev/ProjectInstructions/addendums/no_mock_repository_runtime_source.md`
- `dev/docs_build/dev/ProjectInstructions/addendums/preservation.md`
- `dev/docs_build/dev/reports/audits/*.md`
- `dev/reports/audits/*.md`
- `dev/archive/docs_build/dev/dod/*.md`
- `dev/archive/docs_build/dev/roadmaps/*.md`
- `dev/project-instructions/README.md` (tiny deprecated pointer only)
Expand Down Expand Up @@ -80,10 +80,10 @@ This `dev/docs_build/dev/pr/BUILD_PR.md`, `dev/docs_build/dev/pr/PLAN_PR.md`, an
- `dev/docs_build/dev/roadmaps/MIDI_STUDIO_V2_ROADMAP.md` (move to root archive)
- `dev/docs_build/dev/roadmaps/phases.txt` (move to root archive)
- `dev/docs_build/dev/roadmaps/README.md` (move to root archive)
- `dev/docs_build/dev/reports/legacy-docs-archive-report.md`
- `dev/docs_build/dev/reports/PR_26177_OWNER_007-project-instructions-single-source-eod-lock*.md`
- `dev/docs_build/dev/reports/codex_review.diff`
- `dev/docs_build/dev/reports/codex_changed_files.txt`
- `dev/reports/legacy-docs-archive-report.md`
- `dev/reports/PR_26177_OWNER_007-project-instructions-single-source-eod-lock*.md`
- `dev/reports/codex_review.diff`
- `dev/reports/codex_changed_files.txt`

## Out Of Scope

Expand Down Expand Up @@ -111,14 +111,14 @@ Test-Path dev/docs_build/dev/validation_checklist.txt
rg -n 'only active Project Instructions source|dev/docs_build/dev/ProjectInstructions/' dev/docs_build/dev/ProjectInstructions
rg -n 'Tool MVP Stacked PR Standard|Creator-testable outcome|What can Mr\\. Q test after applying this ZIP|What Playwright tests|What Mr\\. Q should manually test|Previous PR dependency|Next PR dependency' dev/docs_build/dev/ProjectInstructions
rg -n 'No Mock Repository Runtime Source|Browser → API → Database|Mock repositories are 100% technical debt|Game Configuration mock repository ready|Seeded demo data is fine only when it is stored in the database and read back through the API' dev/docs_build/dev/ProjectInstructions
rg -n 'dev/archive/docs_build/dev/ProjectInstructions/history|dev/archive/docs_build/dev/dod|dev/archive/docs_build/dev/roadmaps' dev/docs_build/dev/ProjectInstructions dev/docs_build/dev/reports/legacy-docs-archive-report.md
rg -n 'dev/archive/docs_build/dev/ProjectInstructions/history|dev/archive/docs_build/dev/dod|dev/archive/docs_build/dev/roadmaps' dev/docs_build/dev/ProjectInstructions dev/reports/legacy-docs-archive-report.md
Test-Path dev/docs_build/dev/archive
Test-Path dev/docs_build/dev/dod
Test-Path dev/docs_build/dev/dod/tool_ui_readiness_dod.md
Test-Path dev/docs_build/dev/roadmaps/MASTER_ROADMAP_ENGINE.md
rg -n 'dev/docs_build/dev/PROJECT_INSTRUCTIONS.md.*source of truth|Codex must always read `dev/docs_build/dev/PROJECT_INSTRUCTIONS.md`|Read `dev/docs_build/dev/PROJECT_INSTRUCTIONS.md`' dev/docs_build/dev/ProjectInstructions project-instructions
git diff --name-status $(git merge-base HEAD origin/main) -- project-instructions
git diff --name-status $(git merge-base HEAD origin/main) -- dev/docs_build/dev/pr dev/docs_build/dev/ProjectInstructions/addendums dev/docs_build/dev/reports/audits
git diff --name-status $(git merge-base HEAD origin/main) -- dev/docs_build/dev/pr dev/docs_build/dev/ProjectInstructions/addendums dev/reports/audits
rg -n "Branch Lifecycle \\(Canonical\\)|Every PR follows exactly three phases|^START$|^WORK$|^END$|Mandatory Hard Stops|tomorrow's official baseline|No commits on main|Never checkout main|Only after ALL four pass" dev/docs_build/dev/ProjectInstructions
git diff --name-only -- src assets toolbox games api serverside package.json package-lock.json dev/docs_build/dev/start_of_day
git diff --check
Expand Down
6 changes: 3 additions & 3 deletions dev/docs_build/dev/PR/reference/OWNER_007_PLAN_PR.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Make `dev/docs_build/dev/ProjectInstructions/` the only active Project Instructi
- Delete stale one-off PR/restart files from `dev/docs_build/dev/` root.
- Move PR-specific docs from `dev/docs_build/dev/` root into `dev/docs_build/dev/pr/`.
- Move active governance/contract docs from `dev/docs_build/dev/` root into `dev/docs_build/dev/ProjectInstructions/addendums/`.
- Move audit outputs from `dev/docs_build/dev/` root into `dev/docs_build/dev/reports/audits/`.
- Move audit outputs from `dev/docs_build/dev/` root into `dev/reports/audits/`.
- Delete stale one-off bundle metadata from `dev/docs_build/dev/` root.
- Add Tool MVP Stacked PR Standard under `dev/docs_build/dev/ProjectInstructions/`.
- Update PR planning/template and report requirements for tool MVP PRs.
Expand All @@ -24,7 +24,7 @@ Make `dev/docs_build/dev/ProjectInstructions/` the only active Project Instructi
- Move active legacy addendums into `dev/docs_build/dev/ProjectInstructions/addendums/`.
- Update active team start and governance docs to reference only `dev/docs_build/dev/ProjectInstructions/`.
- Add EOD main lock, next-day reset, team PR branch creation gate, and canonical START / WORK / END branch lifecycle rules.
- Add required Codex reports under `dev/docs_build/dev/reports/`.
- Add required Codex reports under `dev/reports/`.

## Out Of Scope

Expand All @@ -40,7 +40,7 @@ Make `dev/docs_build/dev/ProjectInstructions/` the only active Project Instructi
3. Confirm `dev/project-instructions/**` has no PR changes except the tiny deprecated pointer.
4. Confirm dev/docs_build/dev root no longer contains active loose instruction, audit, contract, or PR files.
5. Confirm moved active governance/contract docs are under `dev/docs_build/dev/ProjectInstructions/addendums/`.
6. Confirm moved audit outputs are under `dev/docs_build/dev/reports/audits/`.
6. Confirm moved audit outputs are under `dev/reports/audits/`.
7. Confirm Tool MVP Stacked PR Standard appears in active ProjectInstructions.
8. Confirm tool MVP PR template/report requirements include Creator-testable outcome, Playwright tests, Mr. Q manual test, stack membership, and previous/next dependency.
9. Confirm No Mock Repository Runtime Source governance appears in active ProjectInstructions.
Expand Down
6 changes: 3 additions & 3 deletions dev/docs_build/dev/PR/reference/pr_koti_layout_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This PR is documentation/contract only. Do not implement gameplay.

Use the validated artifacts from the prior workflow pass:

- `tmp/uat_exports/king_of_the_iceberg_layout_snapshot.json`
- `tmp/uat_tool_layout_workflow_results.json`
- `dev/docs_build/dev/reports/PR_tool_layout_workflow_baseline_report.md`
- `dev/workspace/artifacts/tmp/uat_exports/king_of_the_iceberg_layout_snapshot.json`
- `dev/workspace/artifacts/tmp/uat_tool_layout_workflow_results.json`
- `dev/reports/PR_tool_layout_workflow_baseline_report.md`

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Browser validation:
Create:

```txt
tmp/pr_tool_fix_fullscreen_exit_state_validation.json
dev/workspace/artifacts/tmp/pr_tool_fix_fullscreen_exit_state_validation.json
```

Include:
Expand All @@ -149,7 +149,7 @@ Include:
Create:

```txt
dev/docs_build/dev/reports/PR_tool_fix_fullscreen_exit_state_report.md
dev/reports/PR_tool_fix_fullscreen_exit_state_report.md
```

Include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Browser validation:
Create:

```txt
tmp/pr_tool_fix_parallax_header_metadata_validation.json
dev/workspace/artifacts/tmp/pr_tool_fix_parallax_header_metadata_validation.json
```

Include:
Expand All @@ -210,7 +210,7 @@ Include:
Create:

```txt
dev/docs_build/dev/reports/PR_tool_fix_parallax_header_metadata_report.md
dev/reports/PR_tool_fix_parallax_header_metadata_report.md
```

Include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Do not invent a new runtime schema in this PR unless the existing tool requires
Create a short report under:

```txt
dev/docs_build/dev/reports/PR_tool_layout_workflow_baseline_report.md
dev/reports/PR_tool_layout_workflow_baseline_report.md
```

The report must include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Remaining hits must be either:
Create:

```txt
dev/docs_build/dev/reports/PR_tool_remove_future_import_hints_report.md
dev/reports/PR_tool_remove_future_import_hints_report.md
```

Include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Run targeted browser validation:
Create:

```txt
tmp/pr_tool_remove_static_header_intro_validation.json
dev/workspace/artifacts/tmp/pr_tool_remove_static_header_intro_validation.json
```

It should include:
Expand All @@ -173,7 +173,7 @@ It should include:
Create:

```txt
dev/docs_build/dev/reports/PR_tool_remove_static_header_intro_report.md
dev/reports/PR_tool_remove_static_header_intro_report.md
```

Include:
Expand Down
8 changes: 4 additions & 4 deletions dev/docs_build/dev/PR/reference/pr_tool_uat_closeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Validate and close UAT for the four target tools:

Use the latest UAT/fix artifacts already in the workspace:

- `tmp/uat_failed_cases_rerun.json`
- `dev/workspace/artifacts/tmp/uat_failed_cases_rerun.json`
- `tmp/interactive_uat_report_4tools.json`
- `dev/docs_build/dev/reports/PR_tool_uat_failure_fix_report.md`
- `dev/reports/PR_tool_uat_failure_fix_report.md`
- Any current tool smoke/UAT reports already produced

Do not create new King of the Iceberg artifacts.
Expand All @@ -37,7 +37,7 @@ Do not create new King of the Iceberg artifacts.
Create:

```txt
dev/docs_build/dev/reports/PR_tool_uat_closeout_report.md
dev/reports/PR_tool_uat_closeout_report.md
```

The report must include:
Expand Down Expand Up @@ -110,7 +110,7 @@ If no JavaScript files change, `node --check` is not required.

## Acceptance Criteria

- `dev/docs_build/dev/reports/PR_tool_uat_closeout_report.md` exists.
- `dev/reports/PR_tool_uat_closeout_report.md` exists.
- All four tools are marked PASS or remaining issues are explicitly documented.
- No King of the Iceberg work is advanced.
- No runtime game code is changed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Perform browser validation:
- Save evidence JSON under:

```txt
tmp/pr_tool_uat_fix_fullscreen_header_wiring_validation.json
dev/workspace/artifacts/tmp/pr_tool_uat_fix_fullscreen_header_wiring_validation.json
```

---
Expand All @@ -145,7 +145,7 @@ tmp/pr_tool_uat_fix_fullscreen_header_wiring_validation.json
Create:

```txt
dev/docs_build/dev/reports/PR_tool_uat_fix_fullscreen_header_wiring_report.md
dev/reports/PR_tool_uat_fix_fullscreen_header_wiring_report.md
```

Report must include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Do not run long samples suite unless a changed file requires it.
Create:

```txt
dev/docs_build/dev/reports/PR_tool_uat_fix_header_asset_browser_report.md
dev/reports/PR_tool_uat_fix_header_asset_browser_report.md
```

Include:
Expand Down
8 changes: 4 additions & 4 deletions dev/docs_build/dev/PR/templates/BUILD_PR.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ git diff --check

Create or update:

- `dev/docs_build/dev/reports/codex_review.diff`
- `dev/docs_build/dev/reports/codex_changed_files.txt`
- PR-specific report under `dev/docs_build/dev/reports/`
- `dev/reports/codex_review.diff`
- `dev/reports/codex_changed_files.txt`
- PR-specific report under `dev/reports/`
- branch validation PASS/FAIL
- requirement checklist PASS/FAIL
- validation lane report
- manual validation notes
- repo-structured ZIP under `tmp/`
- repo-structured ZIP under `dev/workspace/artifacts/tmp/`
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ Existing Project Instructions outside `dev/docs_build/dev/ProjectInstructions/`

- `dev/docs_build/dev/ProjectInstructions/` owns governance, team instructions, standards, and addendums.
- `dev/docs_build/dev/PR/` owns PR workflow documents, templates, and examples.
- `dev/docs_build/dev/reports/` owns generated reports, audits, and validation artifacts.
- `dev/reports/` owns generated reports and audits.
- `dev/workspace/artifacts/` owns generated non-report artifacts, repo-structured ZIPs, and local temporary workspace output.
- root `dev/archive/` owns historical reference material only.

## Team Backlog, SOD, And EOD Governance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ No exceptions.
Minimum ZIP contents:

- changed or preserved repo files from the run, stored at repo-relative paths
- required reports under `dev/docs_build/dev/reports/`
- required reports under `dev/reports/`

ZIP artifacts must be written under:

```text
dev/workspace/artifacts/tmp/
```

Reports must remain flat under `dev/reports/`. Use descriptive filenames that include the PR, team, runner, or lane context instead of nested team or runner report folders.

Optional:

Expand All @@ -36,6 +44,8 @@ Optional:
- validation.txt
- generated artifacts

Generated non-report artifacts must live under `dev/workspace/artifacts/`.

## Completion Reporting

Codex responses must include:
Expand Down
Loading
Loading