Skip to content

Commit 75d481b

Browse files
committed
Replace technical terminology with creator-friendly language in Assets - PR_26163_084-assets-fun-factor-and-foundry-bot
1 parent db85244 commit 75d481b

8 files changed

Lines changed: 478 additions & 2633 deletions

File tree

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# PR_26163_084-assets-fun-factor-and-foundry-bot
2+
3+
## Branch Validation
4+
5+
- PASS: Current branch is `main`.
6+
- PASS: Expected branch is `main`.
7+
- PASS: Local branches found: `main`.
8+
- PASS: Worktree was clean before implementation.
9+
10+
## Requirement Checklist
11+
12+
- PASS: Read `docs_build/dev/PROJECT_INSTRUCTIONS.md` before changes.
13+
- PASS: Continued `PR_26163_084-assets-fun-factor-and-foundry-bot`. No existing `PR_26163_084` report file was present before this run, so this report was created with the requested terminology cleanup evidence.
14+
- PASS: Added beginner-friendly creator language review to `toolbox/assets`.
15+
- PASS: Added Foundry Bot guidance for beginner creators in `toolbox/assets/index.html`.
16+
- PASS: Foundry Bot copy uses beginner creator language, not professional developer language.
17+
- PASS: Removed user-facing `GDD` and `manifest` terms from the rendered Assets page; none were present in the scoped Assets source before or after this PR.
18+
- PASS: Replaced visible technical wording where practical: `owner-scoped`, `catalog records`, `workspace tags`, `Repository Tables`, `Rows`, `metadata`, and `Reference-only`.
19+
- PASS: Used `Game Design` rather than `GDD`.
20+
- PASS: Avoided user-facing `tool state`.
21+
- PASS: Avoided user-facing `workspace` in the rendered Assets page.
22+
23+
## Terminology Cleanup Evidence
24+
25+
- PASS: `toolbox/assets/index.html` lede now says: `Add artwork, sounds, music, fonts, and other resources to your game.`
26+
- PASS: `toolbox/assets/index.html` center panel now uses `Asset Library` instead of `Asset Library Catalog`.
27+
- PASS: `toolbox/assets/index.html` now uses `Game Tags` and `No game tags added yet.` instead of workspace-tag wording.
28+
- PASS: `toolbox/assets/index.html` now uses `Status Details` with `Area` and `Count` instead of `Repository Tables`, `Table`, and `Rows`.
29+
- PASS: `toolbox/assets/assets.js` now renders `No game tags added yet.` after runtime refresh.
30+
- PASS: `toolbox/assets/assets.js` now renders `No selected asset details.` instead of metadata wording.
31+
- PASS: `toolbox/assets/assets.js` now renders `1 asset ready for your game.` / `<n> assets ready for your game.` instead of asset catalog record wording.
32+
- PASS: `toolbox/assets/assets.js` now renders `Viewing asset.` and `Editing asset.` instead of asset catalog record wording.
33+
- PASS: `toolbox/assets/assets.js` source help now says beginner-friendly phrases such as `Upload artwork for characters, enemies, worlds, icons, and menus.` and `Connect sprites to artwork you already added.`
34+
35+
## Foundry Bot Evidence
36+
37+
- PASS: Added Foundry Bot accordion to the Assets left setup column.
38+
- PASS: Foundry Bot copy:
39+
- `Hi! I'm Foundry Bot.`
40+
- `Upload artwork, sounds, and fonts for your game.`
41+
- `You can connect assets to characters, enemies, worlds, and other game features.`
42+
- `Need ideas? Start by describing your game in Game Design.`
43+
- PASS: Playwright asserts all four Foundry Bot guidance lines are present on the rendered Assets page.
44+
- PASS: Playwright asserts rendered Assets page text does not contain `GDD`, `manifest`, `tool state`, `workspace`, or `catalog record`.
45+
46+
## Search Evidence
47+
48+
- PASS: `rg -n "GDD|manifest|tool state|owner-scoped|catalog record|catalog records|workspace tags|No workspace tags|Reference-only|No valid reference source|No reference sources" toolbox/assets/index.html toolbox/assets/assets.js` returned no matches.
49+
- PASS: `rg -n "Hi! I'm Foundry Bot|Upload artwork, sounds, and fonts for your game|connect assets to characters, enemies, worlds|Game Design" toolbox/assets/index.html tests/playwright/tools/AssetToolMockRepository.spec.mjs` found the expected page copy and Playwright assertions.
50+
51+
## Impacted Lanes
52+
53+
- Toolbox Assets runtime/UI text lane.
54+
- Assets targeted Playwright recovery/UAT lane.
55+
- Project Workspace contract lane, because `npm run test:workspace-v2` was explicitly required. The script name is legacy; user-facing product language remains Project Workspace.
56+
57+
## Skipped Lanes
58+
59+
- Full samples smoke: SKIP. No sample JSON or sample runtime behavior changed.
60+
- Engine runtime: SKIP. No engine behavior changed.
61+
- Broad toolbox smoke: SKIP. This PR is scoped to Assets user-facing language and targeted Assets validation.
62+
63+
## Validation Performed
64+
65+
- PASS: `git branch --show-current` -> `main`.
66+
- PASS: `git branch --list` -> `* main`.
67+
- PASS: `git status --short` before changes -> no output.
68+
- PASS: `node --check toolbox/assets/assets.js`.
69+
- PASS: `node --check tests/playwright/tools/AssetToolMockRepository.spec.mjs`.
70+
- PASS: `Select-String -Path toolbox/assets/index.html -Pattern '<style\\b'` -> no output.
71+
- PASS: `Select-String -Path toolbox/assets/index.html -Pattern '<script(?![^>]*\\bsrc=)'` -> no output.
72+
- PASS: `git diff --check -- toolbox/assets/index.html toolbox/assets/assets.js tests/playwright/tools/AssetToolMockRepository.spec.mjs docs_build/dev/reports/playwright_v8_coverage_report.txt docs_build/dev/reports/coverage_changed_js_guardrail.txt`.
73+
- PASS: `npx.cmd playwright test tests/playwright/tools/AssetToolMockRepository.spec.mjs --workers=1 --reporter=list` -> 15 passed.
74+
- PASS: `npm.cmd run test:workspace-v2` -> workspace-contract lane passed, 5 Playwright tests passed.
75+
76+
## Playwright Result
77+
78+
- PASS: Targeted Assets Playwright: 15/15 passed.
79+
- PASS: Required Project Workspace validation command: 5/5 passed.
80+
81+
## V8 Coverage
82+
83+
- Report: `docs_build/dev/reports/playwright_v8_coverage_report.txt`.
84+
- PASS: `toolbox/assets/assets.js` collected browser V8 coverage at 93%.
85+
- PASS: `docs_build/dev/reports/coverage_changed_js_guardrail.txt` reports no changed runtime JS coverage warnings.
86+
87+
## Review Artifacts
88+
89+
- `docs_build/dev/reports/PR_26163_084-assets-fun-factor-and-foundry-bot.md`
90+
- `docs_build/dev/reports/codex_review.diff`
91+
- `docs_build/dev/reports/codex_changed_files.txt`
92+
- `docs_build/dev/reports/playwright_v8_coverage_report.txt`
93+
- `docs_build/dev/reports/coverage_changed_js_guardrail.txt`
94+
95+
## Manual Validation Notes
96+
97+
1. Open `/toolbox/assets/index.html`.
98+
2. Confirm Foundry Bot appears in the left column with beginner creator guidance.
99+
3. Confirm the page uses `Game Design`, not `GDD`.
100+
4. Confirm the rendered Assets page does not show `manifest`, `tool state`, or `workspace`.
101+
5. Confirm the Asset Library still supports upload, tag, view, edit, and delete flows.
102+
103+
## Samples Decision
104+
105+
- SKIP: Full samples smoke was not run because this PR only changes Assets user-facing language and targeted Assets tests.
Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
# git status --short
2-
M docs_build/dev/reports/codex_changed_files.txt
3-
M docs_build/dev/reports/codex_review.diff
4-
M docs_build/dev/reports/coverage_changed_js_guardrail.txt
2+
M docs_build/dev/reports/coverage_changed_js_guardrail.txt
53
M docs_build/dev/reports/playwright_v8_coverage_report.txt
64
M tests/playwright/tools/AssetToolMockRepository.spec.mjs
75
M toolbox/assets/assets.js
86
M toolbox/assets/index.html
9-
?? docs_build/dev/reports/PR_26163_083-assets-upload-cleanup-fixes.md
7+
?? docs_build/dev/reports/PR_26163_084-assets-fun-factor-and-foundry-bot.md
108

119
# git ls-files --others --exclude-standard
12-
docs_build/dev/reports/PR_26163_083-assets-upload-cleanup-fixes.md
10+
docs_build/dev/reports/PR_26163_084-assets-fun-factor-and-foundry-bot.md
1311

1412
# git diff --stat
15-
docs_build/dev/reports/codex_changed_files.txt | 65 +-
16-
docs_build/dev/reports/codex_review.diff | 1786 ++++++--------------
17-
.../dev/reports/coverage_changed_js_guardrail.txt | 2 +-
18-
.../dev/reports/playwright_v8_coverage_report.txt | 8 +-
19-
.../tools/AssetToolMockRepository.spec.mjs | 127 +-
20-
toolbox/assets/assets.js | 134 +-
21-
toolbox/assets/index.html | 48 -
22-
7 files changed, 669 insertions(+), 1501 deletions(-)
13+
.../dev/reports/coverage_changed_js_guardrail.txt | 5 +--
14+
.../dev/reports/playwright_v8_coverage_report.txt | 8 ++--
15+
.../tools/AssetToolMockRepository.spec.mjs | 15 +++++++-
16+
toolbox/assets/assets.js | 33 +++++++++--------
17+
toolbox/assets/index.html | 43 +++++++++++++---------
18+
5 files changed, 61 insertions(+), 43 deletions(-)

0 commit comments

Comments
 (0)