[Feature]: last-edited dates on instruction pages

未关闭
  • 哪里不对？
#4 3 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
html
领域
documentation

调研方向

从 https://intel.github.io/SDM/sdm.html?instr=ADDSS 的指令页面开始，检查其内容是如何从 intel/SDM 仓库生成的。确定如何将实质性的文档更改与 CSS 编辑和拼写错误修复区分开来，然后定义最终日期应如何显示在每个页面上。完成的标准是指令页面显示一个能够反映实质性内容更改的、有意义的最后编辑日期。

由索引模型根据 Issue 内容生成。

描述

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! :)

主要语言
HTML
星标
66
派生
5
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

intel/SDM 的其他 Issue

查看 intel/SDM 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。