Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add "Warning/Tip" to top of older Release Notes that they might have outdated info

Abierto
  • ¿Algo no está bien?
#1,501 1 comentario 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Localiza las Release Notes que cubren la quinta versión más antigua y las anteriores, y comprueba después cómo el tema representa un encabezado de advertencia. Aplica el aviso propuesto de información obsoleta a las notas que cumplan los requisitos sin reescribir su contenido histórico. La tarea estará terminada cuando las notas más antiguas muestren la advertencia de forma coherente, mientras que las Release Notes más nuevas permanezcan sin cambios.

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

Descripción

As mentioned #536, search results can surface some pretty old Release Notes that have outdated info. A couple of options:

  1. Leave it as it is

  2. Review each release note and edit to highlight outdated info

  3. Just add a warning header (yellow formatting in the theme) to the top of older (say 5 releases back and older) release notes with something like (first pass):

    These are the Release Notes for <version>. If you have arrived here via Search, please keep in mind that information here may (or may not ) be outdated. Features may have been renamed, functionality added or removed, or other changes may have been made after this Release. Please refer to the other documentation sources on this site for updated information.

I'd vote for the third, personally. Regarding 2 - I think Release Notes are a historical archive and shouldn't be changed post de defacto. It would also be a major (and continual) undertaking to review and update.

While the first option is a possibility, the point made in #536 is a fair one that I'd like to see addressed in some way.

Lenguaje dominante
TypeScript
Estrellas
260
Forks
563
Merge medio
4 h 36 min
PR fusionados (30 d)
16

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 nushell/nushell.github.io

Todos los issues de nushell/nushell.github.io

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.