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
  •  
  •  
  •  
19 changes: 13 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,19 @@ NEXT_COMMAND.txt
node_modules/
tests/results/
tests/results/**
dev/workspace/artifacts/tmp/
dev/workspace/artifacts/tmp/**
dev/workspace/artifacts/tmp/test-results/
dev/workspace/artifacts/tmp/test-results/**
dev/workspace/tmp/
dev/workspace/tmp/**
dev/workspace/test-results/
dev/workspace/test-results/**
dev/workspace/zips/
dev/workspace/zips/**
dev/workspace/logs/
dev/workspace/logs/**
dev/workspace/generated/
dev/workspace/generated/**
tmp/
scripts/untracked/
dev/scripts/untracked/
dev/scripts/untracked/**
projects/

# Codex files
Expand All @@ -49,4 +56,4 @@ docs/dev/reports/playwright_v8_coverage_report.txt

# Game Foundry Studio project files
assets/*.gfsp
dev/docs_build/dev/ProjectInstructions.zip
dev/build/ProjectInstructions.zip
10 changes: 5 additions & 5 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 active development governance in [dev/docs_build/dev/ProjectInstructions/](dev/docs_build/dev/ProjectInstructions/)
2. Explore active development governance in [dev/build/ProjectInstructions/](dev/build/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 [dev/docs_build/dev/](dev/docs_build/dev/) and [dev/docs_build/dev/PR/](dev/docs_build/dev/PR/)
6. Follow the workflow in [dev/build/ProjectInstructions/](dev/build/ProjectInstructions/) and [dev/build/pr/](dev/build/pr/)

---

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

---

## 📚 Documentation Map

- [docs/README.md](docs/README.md) → top-level documentation index
- [docs/architecture/](docs/architecture/) → durable architecture and boundary contracts
- [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/build/pr/](dev/build/pr/) → preserved PR history and architecture evolution
- [dev/build/ProjectInstructions/](dev/build/ProjectInstructions/) → active governance and workflow controls
- [dev/reports/](dev/reports/) → active report artifacts
- [dev/archive/](dev/archive/) → archived dev-ops notes and generated reports

Expand Down
4 changes: 2 additions & 2 deletions admin/site-setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ <h2>Inspector</h2>
<details class="vertical-accordion" open>
<summary>DDL/DML Review</summary>
<div class="accordion-body content-stack">
<p>DDL remains under dev/docs_build/database/ddl/.</p>
<p>Setup review DML is grouped under dev/docs_build/database/dml/. Runtime setup checks run through the server API.</p>
<p>DDL remains under dev/build/database/ddl/.</p>
<p>Setup review DML is grouped under dev/build/database/dml/. Runtime setup checks run through the server API.</p>
</div>
</details>
</div>
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ This folder is the destination shell for non-deployable development workspace ma

## Governance Workspace

- `dev/docs_build/` owns active development governance and PR workflow material.
- `dev/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/workspace/` owns generated non-report artifacts and local temporary workspace output.
- `dev/tests/` owns non-deployable tests.
- `dev/scripts/` owns development-only scripts and runners.
- `dev/config/` owns development-only runner and tooling configuration.
- `dev/archive/` owns historical development reference material.
- `dev/project-instructions/` is deprecated reference only; active Project Instructions live under `dev/docs_build/dev/ProjectInstructions/`.
- `dev/build/ProjectInstructions/` is the only active Project Instructions source.

## Data Boundary

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@ Full samples smoke test was skipped per request. This PR changes root IA, deprec
## Manual Validation Notes

1. Open `toolbox/index.html` and confirm each root tool card opens its `toolbox/<toolname>/index.html` destination.
2. Open `toolbox/_tool_template-v2/index.html` and confirm Theme V2 CSS, partials, favicon, and scripts load from root paths.
2. Open `dev/templates/tool-template-v2.html` and confirm Theme V2 CSS, partials, favicon, and scripts load from root paths.
3. Open `archive/v1-v2/games/index.html` and confirm the deprecated games index remains reachable.
4. Open `docs/index.html`, `docs/faq.html`, `docs/reference.html`, and `docs/support.html` and confirm `/docs/` remains user-facing only.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PR_26154_022 Template Consistency Audit

Sources compared: `/_page_template_v2.html` for public/root pages and `toolbox/_tool_template-v2/index.html` for active toolbox pages.
Sources compared: `/dev/templates/page-template-v2.html` for public/root pages and `dev/templates/tool-template-v2.html` for active toolbox pages.
Audit scope was limited to CSS wiring, shared partial labels/slots, shared IDs, header/nav/footer presence, ToolDisplayMode host wiring, left/center/right shell markers, and consistency-critical attributes.

## Fixes Applied
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Baseline used: `PR_26154_025-cloud-template-styles-cleanup`.

## Scope

- Re-ran the public/root page audit against `_page_template_v2.html`.
- Re-ran the public/root page audit against `dev/templates/page-template-v2.html`.
- Re-ran the active toolbox page audit against `toolbox/_tool_template-v2`.
- Fixed only clear template contract gaps.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Task: PR_26152_278-theme-v2-asset-ssot-inventory
- `src` -> `../assets/js/gamefoundry-partials.js`
- `src` -> `../assets/js/tool-display-mode.js`

### `/_page_template_v2.html`
### `/dev/templates/page-template-v2.html`
- `href` -> `assets/images/favicon.svg`
- `href` -> `assets/css/theme/v2/theme.css`
- `src` -> `assets/js/gamefoundry-partials.js`
Expand All @@ -219,7 +219,7 @@ Task: PR_26152_278-theme-v2-asset-ssot-inventory
- `src` -> `assets/js/tool-display-mode.js`
- `base` -> `../../../../../GameFoundryStudio/`

### `toolbox/_tool_template-v2/index.html`
### `dev/templates/tool-template-v2.html`
- `href` -> `assets/images/favicon.svg`
- `href` -> `assets/css/styles.css`
- `href` -> `assets/css/theme/v2/theme.css`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Baseline used: `PR_26154_034-toolbox-inventory-convergence`.
| Asset | Status | Notes |
| --- | --- | --- |
| `assets/theme-v2/js/gamefoundry-partials.js` | Active | Loaded by public/root pages, games index/type pages, active toolbox pages, and templates. |
| `assets/theme-v2/js/tool-display-mode.js` | Active | Loaded by active toolbox pages and `toolbox/_tool_template-v2/index.html`. |
| `assets/theme-v2/js/tool-display-mode.js` | Active | Loaded by active toolbox pages and `dev/templates/tool-template-v2.html`. |
| `assets/theme-v2/js/account-controls.js` | Active | Loaded by `admin/controls.html`. |

## Partials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Task: PR_26152_280-theme-v2-reference-rewire

## Rewired Files

- `toolbox/_tool_template-v2/index.html`
- `dev/templates/tool-template-v2.html`
- `toolbox/ai-assistant.html`
- `toolbox/animation-studio.html`
- `toolbox/asset-studio.html`
Expand Down Expand Up @@ -65,7 +65,7 @@ Task: PR_26152_280-theme-v2-reference-rewire
- `GameFoundryStudio/tools/publisher.html`
- `GameFoundryStudio/tools/world-vector-studio.html`
- `GameFoundryStudio/tools.html`
- `/_page_template_v2.html`
- `/dev/templates/page-template-v2.html`
- `retired Theme V2 tool template`
- `toolbox/tools-page-accordions.js`

Expand Down
155 changes: 155 additions & 0 deletions dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# Project Instructions Operating System

Read `README.txt` first.

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

## Active Source

`dev/build/ProjectInstructions/` is the only active Project Instructions source.

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

## Purpose

The Project Instructions operating system provides additive governance for:

- backlog ownership
- team assignments
- multi-team branch and scope rules
- documentation ownership
- repository directory ownership
- Build Path status synchronization
- tile overlay status behavior
- deprecation workflow
- contract and platform standards
- archive and history preservation
- recognized project instruction/reference files
- environment governance
- tool and gameplay contract governance

## Preservation

Existing Project Instructions outside `dev/build/ProjectInstructions/` remain preserved only as deprecated reference material. When guidance conflicts, active files under `dev/build/ProjectInstructions/` win unless OWNER explicitly approves a newer governance change.

## Folders

- `addendums/` contains additive governance rules.
- `backlog/` contains the central backlog file, `BACKLOG_MASTER.md`.
- `team_assignments/` contains current team assignment records.
- `standards/` contains active contract, model, and platform standards.
- `deprecation/` contains deprecation workflow documentation.
- Retained reference material belongs under the repository root `dev/archive/` tree, not under `dev/build/dev/`.
- History snapshots belong under `dev/archive/legacy-docs-build/ProjectInstructions/history/`.

## Recognized Project Reference Files

`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.

## Documentation Ownership

`dev/build/ProjectInstructions/addendums/documentation_ownership.md` defines the active documentation ownership model:

- `dev/build/ProjectInstructions/` owns governance, team instructions, standards, and addendums.
- `dev/build/pr/` owns PR workflow documents, templates, and examples.
- `dev/reports/` owns generated reports and audits.
- `dev/workspace/` 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

`dev/build/ProjectInstructions/addendums/team_backlog_sod_eod_standard.md` defines required Start of Day team briefings, End of Day team summaries, active team backlog fields, completion percentage update points, backlog-driven next PR selection, and official military team-name spelling.

## Canonical Governance Owners

When active guidance overlaps, use these canonical owner documents:

- Workflow and Product Owner testable completion: `dev/build/ProjectInstructions/addendums/pr_workflow.md`
- START / WORK / END lifecycle, branch gates, mandatory hard stops, and EOD main lock: `dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md`
- Repository directory ownership, final root standard, final `src/` layer standard, final `dev/` workspace standard, and restructure boundaries: `dev/build/ProjectInstructions/addendums/repository_directory_standard.md`
- Page-level Playwright organization and completion coverage: `dev/build/ProjectInstructions/addendums/test_structure_standardization.md`
- API/environment model and `Browser -> API -> Database` rule: `dev/build/ProjectInstructions/addendums/environment_governance_model.md`
- Environment variable, URL, R2 prefix, and feature flag configuration: `dev/build/ProjectInstructions/addendums/environment_configuration_standards.md`
- Team backlog fields, completion percentages, and next logical PR ownership: `dev/build/ProjectInstructions/addendums/team_backlog_sod_eod_standard.md`
- Team ownership and assignment routing: `dev/build/ProjectInstructions/team_assignments/team_ownership.md`

Other active addendums may summarize these rules, but they must point back to the canonical owner document and must not create a competing active rule.

## Environment Governance

`dev/build/ProjectInstructions/addendums/environment_governance_model.md` defines the official environment model, environment invariance rule, shared API/service contract rule, required Supabase/Postgres/R2 services, required R2 prefixes, and SQLite retired status.

`dev/build/ProjectInstructions/addendums/environment_configuration_standards.md` defines official `.env` file names, environment variable values, host/domain configuration, API URL configuration, R2 prefix configuration, and feature flag governance.

## Tool And Contract Governance

`dev/build/ProjectInstructions/addendums/workspace_v2_playwright_gate.md` defines the Workspace Manager V2 Playwright validation gate.

`dev/build/ProjectInstructions/addendums/samples2tools_adapter_guidance.md` defines the shared sample-to-tool launch and hydration guidance.

`dev/build/ProjectInstructions/addendums/koti_layout_contract.md` defines the King of the Iceberg layout data contract.

`dev/build/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md` defines the Creator-facing stacked PR standard for tool MVP work.

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

## Standards

Active contract, model, and platform standards live under:

`dev/build/ProjectInstructions/standards/`

## Single Source and Main Lock Governance

`dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md` defines the single active Project Instructions source, canonical START / WORK / END branch lifecycle, EOD main lock, next-day reset, team branch creation gate, daily synchronization baseline, and mandatory hard stops.

## Merge Control

No PR in this operating system is merged without explicit owner approval.

## OWNER Governance

OWNER override wording:

`OWNER override approved: <reason>`

OWNER follows the same safety rules:
- Team OWNER follows the same one-active-branch discipline as every team.
- One active OWNER assignment at a time.
- OWNER may override team locks, but may not silently delete, rewrite, or remove protected instructions.
- OWNER override must be explicitly documented.

## Four-Team Ownership Alignment

The single authoritative four-team ownership definition is:

`dev/build/ProjectInstructions/team_assignments/team_ownership.md`

Use the `Current Four-Team Ownership Model` section there for team ownership, assignment routing, and cross-team scope checks.

Rules:
- Teams pull backlog items only from their ownership area unless OWNER explicitly reassigns or splits the work.
- Cross-team work requires OWNER approval and must identify the owning team for each PR.
- Team start commands must remain aligned with this ownership model.

## Current Active Ownership Lanes

OWNER override approved.

The current active ownership lanes are:

- Team Alfa
- Team Bravo
- Team Charlie
- Team Delta
- Team Golf
- Team OWNER

Migration note:
Team Gamma is retired. Team Golf is the replacement active ownership lane.

Rules:
- Do not rewrite historical PR references that mention Team Gamma.
- Do not rename historical branches that contain Gamma.
- Team Golf may own newly assigned work, review packets, cleanup, release, or OWNER-directed cross-team work.
- Team Golf must not silently take backlog ownership from Alfa, Bravo, Charlie, or Delta; cross-team work requires OWNER approval.
Loading
Loading