Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đã đóng
  • Có gì không ổn?
#142 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
52/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, json, markdown
Lĩnh vực
content, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
58
Fork
15
Merge trung bình
16 giờ 53 phút
Pull request đã merge (30 ngày)
14

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/Free-Game-Dev-Assets

Tất cả issue của TMHSDigital/Free-Game-Dev-Assets

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.