Skip to content

Commit 551df14

Browse files
TMHSDigitalclaude
andcommitted
docs: README filter list, catalog README entry steps and guides (#270); stale and misplaced comments (#259)
Closes #259 Closes #270 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LpkeXQPaUhxjgqdqnk6BrJ
1 parent 058219a commit 551df14

8 files changed

Lines changed: 19 additions & 21 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: Validate catalog
44
# top-level Markdown files, and the whole run takes seconds.
55
#
66
# Runs on pull requests, and as the first job of pages.yml on every push to
7-
# main (so a push builds once, not three times). With `upload-dist` the
7+
# main (so a push builds only here: once in this job and once in node-minimum). With `upload-dist` the
88
# checkout has full history (the sitemap's lastmod dates come from git) and
99
# the built site is uploaded as the Pages artifact for pages.yml to deploy.
1010
on:

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,9 @@ is a page on the site.
151151
## Browse the catalog
152152

153153
The [website](https://tmhsdigital.github.io/Free-Game-Dev-Assets/) searches all 418 entries
154-
and filters them by category, commercial use, attribution, review status and 2D camera
155-
view. Press `/` to search. Filtered views and individual entries have their own URLs, so you can send
154+
and filters them by category, licence, format, engine, commercial use, attribution, review
155+
status and 2D camera view, sorted as you choose. Press `/` to search, and keep the sources you
156+
are weighing on a shortlist. Filtered views and individual entries have their own URLs, so you can send
156157
someone exactly what you are looking at.
157158

158159
| Category | Entries | Focus | Index |

‎catalog/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Catalog
22

3-
One markdown file per source under a category folder. Copy [`TEMPLATE.md`](TEMPLATE.md) to add entries.
3+
One markdown file per source under a category folder. To add one, run `npm run new-entry -- <category> <id>`: it copies [`TEMPLATE.md`](TEMPLATE.md), fills in the id and date and checks the id is unique (see [CONTRIBUTING](../CONTRIBUTING.md#adding-an-entry)).
44

55
| Category | Entries | Path | Focus |
66
| --- | ---: | --- | --- |
@@ -15,7 +15,7 @@ One markdown file per source under a category folder. Copy [`TEMPLATE.md`](TEMPL
1515
| Animation | 18 | [`animation/`](animation/) | MoCap, character clips |
1616
| Video | 13 | [`video/`](video/) | Stock footage, archival clips |
1717

18-
Guides: [`docs/licenses.md`](../docs/licenses.md) · [`docs/provenance.md`](../docs/provenance.md) · [`docs/high-risk.md`](../docs/high-risk.md) · [`docs/fivem.md`](../docs/fivem.md) · [`docs/ai-assets.md`](../docs/ai-assets.md) · [`docs/trust-score.md`](../docs/trust-score.md) · [`docs/fonts.md`](../docs/fonts.md) · [`docs/geodata.md`](../docs/geodata.md) · [`docs/game-vs-video-licensing.md`](../docs/game-vs-video-licensing.md) · [`docs/godot-budget-stack.md`](../docs/godot-budget-stack.md) · [`docs/unreal.md`](../docs/unreal.md)
18+
Guides: [`docs/licenses.md`](../docs/licenses.md) · [`docs/provenance.md`](../docs/provenance.md) · [`docs/high-risk.md`](../docs/high-risk.md) · [`docs/fivem.md`](../docs/fivem.md) · [`docs/ai-assets.md`](../docs/ai-assets.md) · [`docs/trust-score.md`](../docs/trust-score.md) · [`docs/fonts.md`](../docs/fonts.md) · [`docs/geodata.md`](../docs/geodata.md) · [`docs/game-vs-video-licensing.md`](../docs/game-vs-video-licensing.md) · [`docs/godot-budget-stack.md`](../docs/godot-budget-stack.md) · [`docs/unreal.md`](../docs/unreal.md) · [`docs/shipping.md`](../docs/shipping.md) · [`docs/data.md`](../docs/data.md) · [`docs/for-publishers.md`](../docs/for-publishers.md)
1919

2020
**Which category.** File a source under the kind of content it mainly gives you.
2121
Software that exists to make one kind of content lives with that content, next to the

‎docs/internal/superpowers/plans/2026-10-23-site-refresh.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
**Tech Stack:** Node 22+ ESM, no npm dependencies; plain CSS and ES modules in the browser; ffmpeg (optional, for the thumbnail script only); GitHub Actions with the already-pinned checkout and setup-node.
1010

11-
**Spec:** `docs/superpowers/specs/2026-10-23-site-refresh-design.md`
11+
**Spec:** `docs/internal/superpowers/specs/2026-10-23-site-refresh-design.md`
1212

1313
## Global Constraints
1414

@@ -462,7 +462,7 @@ git commit -m "site: entry page image strip and one primary action; stack picks
462462

463463
**Files:**
464464
- Create: `.github/workflows/thumbs.yml`
465-
- Modify: `site/README.md` (new files, `npm run thumbs`, manifest, category pages, fonts), `README.md` site section if it lists site features (one line on previews), `docs/superpowers/specs/2026-10-23-site-refresh-design.md` (no change unless a decision moved)
465+
- Modify: `site/README.md` (new files, `npm run thumbs`, manifest, category pages, fonts), `README.md` site section if it lists site features (one line on previews), `docs/internal/superpowers/specs/2026-10-23-site-refresh-design.md` (no change unless a decision moved)
466466

467467
- [ ] **Step 1: Write `.github/workflows/thumbs.yml`** mirroring `reverify.yml`: `on: schedule: cron "0 9 1 * *"` and `workflow_dispatch`; `permissions: contents: write, issues: write`; steps: checkout (same pinned SHA), setup-node (same pinned SHA), `sudo apt-get install -y ffmpeg` guarded by `if ! command -v ffmpeg`, `node site/thumbs.mjs --report thumbs-report.md` with `id: run`, then if `steps.run.outputs.changed != '0'`: configure git user `github-actions[bot]`, `branch=thumbs/$(date -u +%Y-%m)`, `git switch -c "$branch"`, `git add site/thumbs.json site/public/thumbs`, commit `thumbs: monthly refresh`, `git push --force origin "$branch"`, then open or update one issue titled `Thumbnail refresh <month>: <n> changes` with the report body plus a first line `Open the pull request: https://github.com/TMHSDigital/Free-Game-Dev-Assets/compare/main...<branch>?expand=1`, using the same `gh issue list` / `edit` / `create` pattern as reverify (label `site`).
468468

‎site/build.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ function headMetaHtml(site, stats, generatedAt, hasCard) {
216216
* Repo-relative file => date of its last commit, from one `git log` over the
217217
* catalog, stacks and docs (DATED_PATHS). The sitemap's lastmod must never be earlier than the
218218
* last content change, and an entry's `verified` date is not that. Empty when
219-
* git is unavailable (a tarball, a shallow CI checkout with no history).
219+
* git is unavailable (a tarball); a shallow checkout dates every file to HEAD.
220220
*/
221221
function lastCommitDates() {
222222
try {

‎site/checks.mjs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -925,8 +925,6 @@ export function checkComparisonLicences(categoryName, readmeText, entriesByRel)
925925
* address. A `javascript:` or `data:` value would render as a live link, and
926926
* escaping HTML does nothing about a scheme.
927927
*/
928-
/** localhost, *.local / *.internal, and IP literals: never a catalog source. */
929-
930928
export function checkEntryUrl(rel, meta) {
931929
const errors = [];
932930
if (empty(meta.url)) return errors; // missing fields are reported elsewhere

‎site/lib/search.mjs‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@ export function passesFilters(entry, state, formatGroups = {}) {
107107
return true;
108108
}
109109

110-
/** Choice params: URL key -> state field. `allowed` supplies each field's legal values. */
111110
/**
112111
* The engine filter. An entry is hidden when it only works in another
113112
* engine: its licence is locked to one (engine_lock), or everything it
@@ -285,14 +284,14 @@ export const SWITCHES = [
285284
["noattr", "noAttr"],
286285
];
287286

287+
/** Longest search query kept from a URL or the search box. */
288+
export const MAX_QUERY = 200;
289+
288290
/**
289291
* State from a query string. A hand-edited or stale link can carry values the
290292
* page has no control for; each one falls back to its default, and the page
291-
* then rewrites the URL without it.
293+
* then rewrites the URL without it. `allowed` supplies each field's legal values.
292294
*/
293-
/** Longest search query kept from a URL or the search box. */
294-
export const MAX_QUERY = 200;
295-
296295
export function readState(search, defaults, allowed) {
297296
const p = new URLSearchParams(search);
298297
const state = { ...defaults };

‎site/lib/shared.mjs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -272,12 +272,6 @@ ${credit ? ` <p class="footer-credit">${PREVIEW_CREDIT_LINE}</p>\n` : ""}
272272
/** Self-hosted fonts (site/public/fonts/, OFL). The body face and the mono face are preloaded; the italic is not. */
273273
export const FONT_FILES = ["fonts/public-sans.woff2", "fonts/ibm-plex-mono-400.woff2"];
274274

275-
/**
276-
* Every ES module each page type loads, entry scripts and their imports, as
277-
* served from dist. The head preloads the whole set so the browser fetches
278-
* them in parallel instead of discovering each import one round trip later.
279-
* lib.test.mjs walks the real import graph and fails if a list drifts.
280-
*/
281275
/**
282276
* The lib modules the browser loads, output name in site/dist -> source in
283277
* site/lib. build.mjs copies exactly these, and lib.test.mjs checks that none
@@ -290,6 +284,12 @@ export const BROWSER_MODULES = {
290284
"shared.mjs": "shared.mjs",
291285
};
292286

287+
/**
288+
* Every ES module each page type loads, entry scripts and their imports, as
289+
* served from dist. The head preloads the whole set so the browser fetches
290+
* them in parallel instead of discovering each import one round trip later.
291+
* lib.test.mjs walks the real import graph and fails if a list drifts.
292+
*/
293293
export const PAGE_MODULES = {
294294
home: ["app.js", "search.js", "cards.mjs", "shared.mjs", "views.js", "shortlist.js", "owes.js"],
295295
entry: ["shortlist.js", "owes.js"],

0 commit comments

Comments
 (0)