Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: add a "Use the data" section and docs/data.md so the exports, field reference and citation are discoverable; add the credit line to catalog.csv

Open
  • Is something wrong?
#142 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, json, markdown
Domain
content, documentation

Research direction

Start with README.md, site/README.md, the export generation code for catalog.csv and the site footer template. Check data.json keys and the current CITATION.cff before writing the field reference and citation examples. Add the README entry point, docs/data.md, CSV columns and footer links; done when exports are discoverable from the README and site pages, the field list matches data.json, and catalog.csv includes the credit line.

Written by the indexing model from the issue text.

Description

documentation priority: high

Why it matters

The exports are the catalog's second product, and the audience of #115 (MCP/CLI), of Google Dataset Search (JSON-LD from #74) and of anyone deciding whether to cite or sponsor. Today they are documented only in the developer file site/README.md, which a visitor would not open, and neither the README nor any site page links to them.

Evidence (at 69387df)

  • README.md never mentions data.json, catalog.csv, feed.xml, reverified.xml, llms.txt, Releases or CITATION.cff. ROADMAP.md:33-34 is the only top-level mention.
  • The homepage has no visible link to any export: the only references are the two <link rel="alternate"> feed tags in site/lib/shared.mjs:239-240. The footers in site/lib/category-page.mjs:54-60, entry-page.mjs:164-170 and freshness.mjs:138-142 carry credit, sponsor and a build stamp, nothing else.
  • The field reference at site/README.md:32-50 omits licenseFamily (present on every data.json entry) and names the stats object without describing it.
  • catalog.csv header: id,name,url,category,license,license_spdx,commercial,attribution_required,formats,tags,added,verified,status,page. No publisher, subcategories, attribution_string or summary, so the one field a shipping developer most needs from a spreadsheet, the credit line, is missing.
  • Nothing explains the two caveats a consumer must carry: that verified is a read date not a validity guarantee (said once at site/README.md:49-50), and that license is the catalog's reading, not the source's SPDX expression.

Suggested approach

Add a short README section "Use the data" (the five URLs, the Releases link, a pointer to docs/data.md) and a docs/data.md with: file list and purpose, the full field table (moved out of site/README.md, leave a pointer), three copy-paste examples (curl + jq for "all CC0 audio with no credit", a 6-line pandas snippet, a feed-reader URL), the caveats paragraph, a stability promise ("field names are stable; optional fields may appear"), and a "How to cite" block rendering CITATION.cff as APA and BibTeX. Add attribution_string, publisher and subcategories columns to the CSV. Put a one-line "Data: JSON / CSV / feeds / llms.txt" link in the site footer template.

Done when

A first-time visitor can find and understand every export from the README and from any site page without opening site/; site/README.md field list matches data.json keys; catalog.csv includes the credit line.

Dominant language
JavaScript
Stars
58
Forks
15
Avg merge
16h 53m
Merged PRs (30d)
14

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TMHSDigital/Free-Game-Dev-Assets

All issues in TMHSDigital/Free-Game-Dev-Assets

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.