[Feature]: last-edited dates on instruction pages

Abierto
  • ¿Algo no está bien?
#4 3 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
html
Área
documentation

Línea de trabajo

Comienza con la página de instrucciones en https://intel.github.io/SDM/sdm.html?instr=ADDSS e inspecciona cómo se genera su contenido a partir del repositorio intel/SDM. Determina cómo distinguir los cambios sustanciales en la documentación de las modificaciones de CSS y las correcciones tipográficas, y luego define cómo debe aparecer en cada página la fecha resultante. Se considera terminado cuando las páginas de instrucciones muestran una fecha significativa de última edición que refleje los cambios sustanciales de contenido.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
HTML
Estrellas
66
Forks
5
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de intel/SDM

Todos los issues de intel/SDM

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.