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

feature: render the guides as site pages instead of bouncing readers to GitHub markdown

Đang mở
  • Có gì không ổn?
#159 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
66/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Start with site/public/index.html and site/public/app.js to trace the Guides links, then read site/lib/markdown.mjs and site/config.json to see how pages and guide files are built. Check how the shared head builder, sitemap, llms.txt, and entry facts panel are generated. Done means all ten guides render in dist, are linked from the home Guides section and matching entry facts, retain an Edit on GitHub link, and Lighthouse SEO remains at 100.

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

Mô tả

feature priority: medium

Why it matters

"Guides" is one of four primary nav items, and the hero promises "Every licence read at the source"; the moment a visitor wants to understand CC-BY vs OFL or the high-risk list, they are sent to github.com with no site nav, search, theme or shortlist. The entry pages' "Entry and evidence" link does the same. Rendered guides also give the entry facts panel somewhere to link a licence name to.

Evidence (at 69387df)

  • site/public/index.html:196-202 #guide-list; site/public/app.js:582-589 builds ${repo}/blob/main/${g.path} links; site/config.json lists ten guides.
  • site/lib/markdown.mjs already renders markdown bodies for entry pages, and the shared head builder gives every page the same head, nav and footer, so the build cost is one more page type.

Suggested approach

Build guide/<id>/ from docs/<file>.md with the site head, nav and breadcrumb; add them to sitemap.xml and llms.txt; link licence names in the entry facts panel to the matching guide anchor (for example "CC-BY 4.0" -> guide/licenses/#cc-by); keep "Edit on GitHub" as a secondary link.

Done when

Ten guide pages in dist, linked from the home Guides section and from entry facts; Lighthouse SEO stays at 100.

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.