[Feature]: last-edited dates on instruction pages

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

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
48/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ệ
html
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với trang hướng dẫn tại https://intel.github.io/SDM/sdm.html?instr=ADDSS và kiểm tra cách nội dung của trang được tạo từ repository intel/SDM. Xác định cách phân biệt các thay đổi đáng kể đối với tài liệu với các chỉnh sửa CSS và sửa lỗi chính tả, sau đó xác định ngày kết quả sẽ xuất hiện như thế nào trên mỗi trang. Hoàn thành có nghĩa là các trang hướng dẫn hiển thị ngày chỉnh sửa lần cuối có ý nghĩa, phản ánh các thay đổi đáng kể về nội dung.

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

Mô tả

enhancement
Feature Description

on a page like https://intel.github.io/SDM/sdm.html?instr=ADDSS, it would be great to have a date for the last time the content on the page was substantially changed. CSS changes of course are probably not interesting, fixing a typo might be, and fixing a bug in an instruction's description probably is!

Why Is This Needed?

intel.github.io is a more authoritative source than something like (the loved and appreciated!) docs at https://www.felixcloutier.com/x86/xadd - I know Félix's site is best effort and every page says as much in the footer. if I'm doing something interesting I historically might have started at that site, fetched a fresh copy of the SDM, and noted which revision of the SDM I was working from.

importantly, I may quote parts of the SDM as explanatory prose in a system I'm working on, and I include the version of the SDM I'm working to help later readers find (or explain the lack of) the quoted passage. quoting intel.github.io is different, since clearly it is not a document one can download, but it is a git repo one can easily fetch the history of. thinking through how I would quote intel.github.io, I would probably include a note like "as of Sept 4, 2026", and know that later I should check the page at that date and potentially update the date to the next time I've verified the docs match the reasoning I'm working with.

a "last updated" date on the page itself helps short-circuit all of this: a git edit date does not immediately indicate if the substantive content has changed in the same way an intentional date describing the encoding rules, description, operation, exceptions, etc would. at that point I wouldn't feel a need to cite either a specific rev of github.com/intel/SDM or corresponding SDM version. in the ideal world, and tragically, I'll stop having an accurate collection of every SDM revision.... alas.

I realize maintaining such a date would be a little complicated, and I don't have great ideas there, sorry! :)

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

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 intel/SDM

Tất cả issue của intel/SDM

Issue tương tự

Thêm issue về Documentation

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.