Skip to content

Commit 46d6906

Browse files
committed
Complete dev-only admin notes cleanup and ownership boundary - PR_26158_041-admin-notes-cleanup
1 parent 31aaaa5 commit 46d6906

13 files changed

Lines changed: 192 additions & 557 deletions

File tree

admin/notes.html

Lines changed: 0 additions & 78 deletions
This file was deleted.

admin/notes/index.txt

Lines changed: 0 additions & 34 deletions
This file was deleted.

admin/notes/other/index.txt

Whitespace-only changes.

assets/theme-v2/js/gamefoundry-partials.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@
7979
"admin-users": "admin/users.html",
8080
"admin-roles": "admin/roles.html",
8181
"admin-moderation": "admin/moderation.html",
82-
"admin-notes": "admin/notes.html",
8382
"admin-analytics": "admin/analytics.html",
8483
"admin-tools-progress": "admin/tools-progress.html",
8584
"cookie-policy": "legal/cookie-policy.html",

assets/theme-v2/partials/header-nav.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@
119119
<a data-nav-link data-route="game-migration" href="toolbox/game-migration/index.html">Game Migration</a>
120120
<a data-nav-link data-route="admin-grouping-colors" href="admin/grouping-colors.html">Grouping Colors</a>
121121
<a data-nav-link data-route="admin-moderation" href="admin/moderation.html">Moderation</a>
122-
<a data-nav-link data-route="admin-notes" href="admin/notes.html">Notes</a>
123122
<a data-nav-link data-route="platform-settings" href="toolbox/platform-settings/index.html">Platform Settings</a>
124123
<a data-nav-link data-route="admin-ratings" href="admin/ratings.html">Ratings</a>
125124
<a data-nav-link data-route="admin-roles" href="admin/roles.html">Roles</a>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Admin Notes Ownership
2+
3+
Admin Notes are dev-only documentation artifacts.
4+
5+
Owned paths:
6+
- `docs_build/dev/admin-notes/index.txt` is the root admin note.
7+
- `docs_build/dev/admin-notes/other/index.txt` is the simple subnote fixture.
8+
- `docs_build/dev/admin-notes/quick-reference.txt` is a linked text-note fixture.
9+
- `docs_build/dev/admin-notes/sample.txt` is a root-relative link example note.
10+
- `docs_build/dev/admin-notes/notes/index.txt` is retained historical admin-note content.
11+
12+
Runtime boundary:
13+
- Admin Notes viewer implementation, when needed for local/dev inspection, belongs under `src/dev-runtime/admin/`.
14+
- Production-facing paths must not link to or fetch `docs_build/dev/admin-notes/`.
15+
- UAT/PROD bundles must not import `src/dev-runtime/admin/`.

docs_build/dev/admin-notes/notes/Other/index.txt

Whitespace-only changes.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# PR_26158_041 Admin Notes Cleanup Report
2+
3+
## Summary
4+
5+
Admin Notes are now dev-owned files under `docs_build/dev/admin-notes/`, with the previous production-facing route, nav link, duplicate production note files, and active Playwright route coverage removed.
6+
7+
The prior viewer implementation was moved from `admin/notes.js` to `src/dev-runtime/admin/admin-notes-viewer.js` so any future local/dev admin-only viewer work starts from the dev-runtime boundary instead of a production path.
8+
9+
## Final Admin Notes Ownership
10+
11+
| Path | Ownership | Status |
12+
| --- | --- | --- |
13+
| `docs_build/dev/admin-notes/README.md` | Dev-only ownership note and boundary reminder. | ADDED |
14+
| `docs_build/dev/admin-notes/index.txt` | Root Admin Notes text. | KEPT |
15+
| `docs_build/dev/admin-notes/other/index.txt` | Simple subnote fixture/content. | KEPT |
16+
| `docs_build/dev/admin-notes/quick-reference.txt` | Linked text-note fixture. | KEPT |
17+
| `docs_build/dev/admin-notes/sample.txt` | Root-relative link example note. | KEPT |
18+
| `docs_build/dev/admin-notes/notes/index.txt` | Historical admin-note content retained under dev docs. | KEPT |
19+
| `src/dev-runtime/admin/admin-notes-viewer.js` | Local/dev-only viewer implementation, not linked from production routes. | MOVED |
20+
21+
## Removed Or Moved Files
22+
23+
| Previous Path | Action | Reason |
24+
| --- | --- | --- |
25+
| `admin/notes.js` | Moved to `src/dev-runtime/admin/admin-notes-viewer.js`. | Admin Notes implementation does not belong in a production-facing admin path. |
26+
| `admin/notes.html` | Removed. | Production-facing Admin Notes route exposed dev docs. |
27+
| `admin/notes/index.txt` | Removed. | Duplicate production-path note content. Dev-owned copy remains under `docs_build/dev/admin-notes/notes/index.txt`. |
28+
| `admin/notes/other/index.txt` | Removed. | Duplicate production-path subnote content. Dev-owned copy remains under `docs_build/dev/admin-notes/other/index.txt`. |
29+
| `docs_build/dev/admin-notes/notes/Other/index.txt` | Removed. | Empty orphaned subnote scaffold. |
30+
| `assets/theme-v2/partials/header-nav.html` Admin Notes nav item | Removed. | Production navigation must not expose dev-only Admin Notes. |
31+
| `assets/theme-v2/js/gamefoundry-partials.js` `admin-notes` route mapping | Removed. | Production route registry must not expose dev-only Admin Notes. |
32+
| `tests/playwright/tools/AdminNotesViewer.spec.mjs` | Removed. | Active Playwright route coverage targeted the retired production `admin/notes.html` page. |
33+
| `tests/helpers/playwrightRepoServer.mjs` Admin Notes directory endpoint | Removed. | Test helper no longer serves Admin Notes filesystem listings for a retired production route. |
34+
35+
## Requirement Checklist
36+
37+
| Requirement | Evidence | Result |
38+
| --- | --- | --- |
39+
| Read `docs_build/dev/PROJECT_INSTRUCTIONS.md` first. | Read before edits. | PASS |
40+
| Complete Admin Notes under `docs_build/dev/admin-notes/`. | Added `README.md`; retained meaningful note files under dev docs. | PASS |
41+
| Move or remove files that do not belong in `docs_build/dev/admin-notes/`. | Removed duplicate `admin/notes/*`; removed empty dev scaffold. | PASS |
42+
| Keep admin notes documentation/dev artifacts out of production-facing paths. | Removed `admin/notes.html`, header link, route mapping, and test-server directory endpoint. | PASS |
43+
| Keep runtime/admin-only implementation under `src/dev-runtime/admin/` if needed. | Moved viewer implementation to `src/dev-runtime/admin/admin-notes-viewer.js`. | PASS |
44+
| Do not place Admin Notes implementation in public assets, toolbox pages, root pages, or production bundles. | Production-facing string audit returned no matches. | PASS |
45+
| Document final file ownership and removed/moved files. | This report plus `docs_build/dev/admin-notes/README.md`. | PASS |
46+
| Do not modify `start_of_day` folders. | `git diff --name-only | rg "start_of_day"` returned no matches. | PASS |
47+
48+
## Validation
49+
50+
| Lane | Command | Result |
51+
| --- | --- | --- |
52+
| Changed-file syntax checks | `node --check assets/theme-v2/js/gamefoundry-partials.js`; `node --check src/dev-runtime/admin/admin-notes-viewer.js`; `node --check tests/helpers/playwrightRepoServer.mjs`; `node --check tests/dev-runtime/AdminNotesBoundary.test.mjs` | PASS |
53+
| Docs/static boundary validation | `node --test tests/dev-runtime/AdminNotesBoundary.test.mjs` | PASS, 3/3 |
54+
| Production path Admin Notes link/import audit | `rg -n "docs_build/dev/admin-notes\|docs_build\\dev\\admin-notes\|admin-notes\|Admin Notes\|data-admin-notes" account admin assets toolbox src --glob '!src/dev-runtime/**' --glob '!archive/v1-v2/**' --glob '!tmp/**'` | PASS, no matches |
55+
| UAT/PROD dev-runtime admin import audit | `rg -n "src/dev-runtime/admin\|src\\dev-runtime\\admin" account admin assets toolbox src --glob '!src/dev-runtime/**' --glob '!archive/v1-v2/**' --glob '!tmp/**'` | PASS, no matches |
56+
| Changed-file whitespace/static validation | `git diff --check` | PASS, Git line-ending warnings only |
57+
58+
## Playwright Decision
59+
60+
Playwright was not run. The production Admin Notes UI route was intentionally retired instead of changed in place, and the old Playwright lane targeted that retired route. Static ownership validation now covers the requested cleanup boundary.
61+
62+
## Remaining Violations
63+
64+
None found in active production-facing paths.
Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
1-
# PR_26158_040 Testing Lane Execution Report
1+
# PR_26158_041 Testing Lane Execution Report
22

33
## Lanes Run
44

55
| Lane | Command | Result |
66
| --- | --- | --- |
7-
| Docs/static content validation | PowerShell content check for required sections in `docs_build/dev/reports/game-deploy-path-plan-report.md` | PASS |
8-
| Changed-file whitespace/static validation | `git diff --check` | PASS |
7+
| Changed-file syntax checks | `node --check assets/theme-v2/js/gamefoundry-partials.js`; `node --check src/dev-runtime/admin/admin-notes-viewer.js`; `node --check tests/helpers/playwrightRepoServer.mjs`; `node --check tests/dev-runtime/AdminNotesBoundary.test.mjs` | PASS |
8+
| Docs/static Admin Notes boundary validation | `node --test tests/dev-runtime/AdminNotesBoundary.test.mjs` | PASS, 3/3 |
9+
| Production path Admin Notes exposure audit | `rg -n "docs_build/dev/admin-notes\|docs_build\\dev\\admin-notes\|admin-notes\|Admin Notes\|data-admin-notes" account admin assets toolbox src --glob '!src/dev-runtime/**' --glob '!archive/v1-v2/**' --glob '!tmp/**'` | PASS, no matches |
10+
| UAT/PROD dev-runtime admin import audit | `rg -n "src/dev-runtime/admin\|src\\dev-runtime\\admin" account admin assets toolbox src --glob '!src/dev-runtime/**' --glob '!archive/v1-v2/**' --glob '!tmp/**'` | PASS, no matches |
11+
| Changed-file whitespace/static validation | `git diff --check` | PASS, Git line-ending warnings only |
912
| start_of_day protection check | `git diff --name-only \| rg "start_of_day"` | PASS, no matches |
1013

1114
## Validation Notes
1215

1316
| Check | Evidence | Result |
1417
| --- | --- | --- |
15-
| MVP end-to-end path is defined. | `game-deploy-path-plan-report.md` includes `Minimum End-To-End Path` and `MVP Flow`. | PASS |
16-
| Current implemented pieces are identified. | Report includes `Current Implemented Pieces` with evidence file paths. | PASS |
17-
| Missing pieces and blockers are identified. | Report includes `Missing Pieces` and `Blockers`. | PASS |
18-
| DB-owned data is separated from generated deploy artifacts. | Report includes `DB Versus Generated Deploy Artifacts`. | PASS |
19-
| UAT deployment path for one playable game is defined. | Report includes `Required UAT Deployment Path For One Playable Game`. | PASS |
20-
| Manifest, asset, debug, publish-state, and public-play gates are defined. | Report includes `Validation Gates`. | PASS |
21-
| Runtime publish behavior was not implemented. | Only docs/reports changed. | PASS |
18+
| Admin Notes docs live under `docs_build/dev/admin-notes/`. | `tests/dev-runtime/AdminNotesBoundary.test.mjs`; `docs_build/dev/admin-notes/README.md`. | PASS |
19+
| Production-facing Admin Notes route was removed. | `admin/notes.html` deleted; header nav and partial route map removed. | PASS |
20+
| Duplicate production-path note files were removed. | `admin/notes/index.txt` and `admin/notes/other/index.txt` deleted. | PASS |
21+
| Runtime implementation moved under dev-runtime admin. | `src/dev-runtime/admin/admin-notes-viewer.js`. | PASS |
22+
| Production paths do not link/import dev Admin Notes content. | Static `rg` audit returned no matches. | PASS |
23+
| UAT/PROD candidate paths do not import `src/dev-runtime/admin/`. | Static `rg` audit returned no matches. | PASS |
2224

2325
## Skipped Lanes
2426

2527
| Lane | Decision | Reason |
2628
| --- | --- | --- |
27-
| Playwright | SKIP | PR is docs/planning only; no runtime, page, API, or UI behavior changed. |
28-
| Full samples smoke | SKIP | No sample loader/framework, runtime, manifest fixture, or sample artifact changed. |
29-
| Node test suite | SKIP | No executable source or test logic changed. |
29+
| Playwright | SKIP | The production Admin Notes route was retired; the old Playwright lane targeted the removed route. Static boundary validation is the requested lane for this cleanup. |
30+
| Full samples smoke | SKIP | No sample loader/framework, sample fixture, or game runtime path changed. |
31+
| Full Node suite | SKIP | Targeted Node syntax and Admin Notes boundary test covered the changed files and requested static ownership validation. |
3032

3133
## Notes
3234

33-
- No V8 coverage was generated for this PR because Playwright was intentionally skipped by request.
34-
- No `start_of_day` folders were modified.
35+
- `git diff --check` emitted line-ending warnings only.
36+
- No `start_of_day` files were modified.

admin/notes.js renamed to src/dev-runtime/admin/admin-notes-viewer.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Dev-runtime only: do not import this viewer from production-facing pages or bundles.
12
const NOTES_DIRECTORY = "docs_build/dev/admin-notes";
23
const DEFAULT_NOTE = "index";
34
const LINK_CLASS = "btn btn--compact primary";

0 commit comments

Comments
 (0)