Add og:image preview cards to docs pages

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

@adamshatzkamer đang làm issue này rồi.

Từ ngày 9/10/2026.

  • #242 của @adamshatzkamer — đang mở

Đá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
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, react
Lĩnh vực
documentation

Hướng nghiên cứu

Start by locating how the website renders docs pages and sets their page metadata, then identify the existing title and description handling. Add and verify the requested Open Graph and Twitter card metadata, including an image with alt text and 1200x630 dimensions. Check a docs URL with the LinkedIn Post Inspector and X/Twitter card validator; per-page image generation is optional.

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

Mô tả

Summary

Docs pages have no og:image, so links shared on LinkedIn, X or Slack show no preview card.

Current behavior

Sharing a docs URL produces a plain link with no image.

Expected behavior

Shared docs links show a preview card with an image, title and description.

Proposed solution

  • Add a default og:image (branded, 1200x630) to all docs pages.
  • Optionally generate per-page images from the page title.
  • Add twitter:card (summary_large_image), og:image:width, og:image:height and og:image:alt.

Acceptance criteria

  • A docs page URL shows a preview card in the LinkedIn Post Inspector and the X/Twitter card validator.
  • Image has alt text and correct dimensions.

Additional context

Found in an audit of gofr.dev AI readiness and discoverability on 2026-10-07.

Ngôn ngữ chính
JavaScript
Star
44
Fork
44
Không có pull request nào được merge trong 30 ngày

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 gofr-dev/website

Tất cả issue của gofr-dev/website

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.