Skip to content

Commit 3a0105b

Browse files
author
DavidQ
committed
Normalize tools README V2 sections and tool listings - PR_26140_083-normalize-tools-readme-v2-sections
1 parent acaf702 commit 3a0105b

4 files changed

Lines changed: 72 additions & 3 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# PR_26140_083 Tools README V2 Normalization Report
2+
3+
## Summary
4+
- Split `docs/tools/README.md` from one mixed `Primary Tool UAT Docs` section into:
5+
- `Primary Tool UAT Docs - Legacy`
6+
- `Primary Tool UAT Docs - V2`
7+
- Added Asset Manager V2 to the V2 UAT list.
8+
- Added Palette Manager V2 to the V2 UAT list.
9+
- Kept Object Vector Studio V2 and World Vector Studio V2 in the V2 section after PR_26140_082.
10+
- Added missing standardized UAT docs for Asset Manager V2 and Palette Manager V2 so the README links resolve.
11+
12+
## Scope
13+
- Documentation only.
14+
- No schema changes.
15+
- No sample JSON changes.
16+
- No runtime behavior changes.
17+
18+
## Playwright Impact
19+
- Playwright impacted: No.
20+
- No Playwright impact. This PR is docs/workflow only.
21+
22+
## Validation
23+
- Ran markdown/link sanity validation for `docs/tools/README.md`.
24+
- Confirmed `Asset Manager V2` appears in `docs/tools/README.md`.
25+
- Confirmed `Palette Manager V2` appears in `docs/tools/README.md`.
26+
- Confirmed `Primary Tool UAT Docs - Legacy` appears in `docs/tools/README.md`.
27+
- Confirmed `Primary Tool UAT Docs - V2` appears in `docs/tools/README.md`.
28+
- Confirmed every local markdown link in `docs/tools/README.md` resolves.
29+
- Ran whitespace sanity validation for the changed docs files with `git diff --check`.
30+
- Confirmed no schema files or sample JSON files were changed by this PR.
31+
32+
## Manual Validation
33+
- Open `docs/tools/README.md`.
34+
- Confirm legacy tools are listed under `Primary Tool UAT Docs - Legacy`.
35+
- Confirm V2 tools are listed under `Primary Tool UAT Docs - V2`.
36+
- Confirm Asset Manager V2 and Palette Manager V2 links open their UAT docs.
37+
38+
## Full Samples Smoke Test
39+
- Not run. This PR is docs-only and does not affect sample runtime behavior.

docs/tools/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ This folder is standardized on UAT documentation.
55
## UAT Standard Path
66
- `docs/tools/<tool-name>/uat.md`
77

8-
## Primary Tool UAT Docs
9-
- [World Vector Studio V2](./world-vector-studio-v2/uat.md)
10-
- [Object Vector Studio V2](./object-vector-studio-v2/uat.md)
8+
## Primary Tool UAT Docs - Legacy
119
- [Tilemap Studio](./tilemap-studio/uat.md)
1210
- [Parallax Scene Studio](./parallax-scene-studio/uat.md)
1311
- [Sprite Editor](./sprite-editor/uat.md)
@@ -25,6 +23,12 @@ This folder is standardized on UAT documentation.
2523
- [Tool Host](./tool-host/uat.md)
2624
- [Tools Index And Registry](./tools-index-registry/uat.md)
2725

26+
## Primary Tool UAT Docs - V2
27+
- [Asset Manager V2](./asset-manager-v2/uat.md)
28+
- [Palette Manager V2](./palette-manager-v2/uat.md)
29+
- [World Vector Studio V2](./world-vector-studio-v2/uat.md)
30+
- [Object Vector Studio V2](./object-vector-studio-v2/uat.md)
31+
2832
## UAT Reports
2933
- [Tool Inventory](../dev/reports/tool_inventory.md)
3034
- [Tool UAT Template](../dev/reports/tool_uat_template.md)

docs/tools/asset-manager-v2/uat.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Asset Manager V2 - UAT
2+
3+
Validate that Asset Manager V2 is the active V2 surface for authoring and validating manifest-owned assets.
4+
5+
## Scope
6+
- Tool: `asset-manager-v2`
7+
- Entry point: `tools/asset-manager-v2/index.html`
8+
- Purpose: create and validate audio, color, data, font, image, localization, shader, and video asset entries for V2 workspace and game manifest flows.
9+
10+
## Expected
11+
- Tool launches from the tools index.
12+
- Tool launches from Workspace Manager V2 when selected game context enables it.
13+
- Asset entries remain owned by the Asset Manager V2 manifest/toolState contract.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Palette Manager V2 - UAT
2+
3+
Validate that Palette Manager V2 is the active V2 surface for editing validated palette swatches.
4+
5+
## Scope
6+
- Tool: `palette-manager-v2`
7+
- Entry point: `tools/palette-manager-v2/index.html`
8+
- Purpose: edit user palette swatches, browse source palettes, manage tags, and publish validated palette data for V2 workspace and game manifest flows.
9+
10+
## Expected
11+
- Tool launches from the tools index.
12+
- Tool launches from Workspace Manager V2 when selected game context enables it.
13+
- Palette swatches remain owned by the Palette Manager V2 manifest/toolState contract.

0 commit comments

Comments
 (0)