Add "Warning/Tip" to top of older Release Notes that they might have outdated info
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
找到涵盖最早的第五个版本及更早版本的 Release Notes,然后检查主题如何表示警告标题。将提议的过时信息通知应用于符合条件的说明,但不要改写其历史内容。完成标准是较旧的说明一致显示警告,而较新的 Release Notes 保持不变。
由索引模型根据 Issue 内容生成。
描述
As mentioned #536, search results can surface some pretty old Release Notes that have outdated info. A couple of options:
-
Leave it as it is
-
Review each release note and edit to highlight outdated info
-
Just add a
warningheader (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.
- 主要语言
- TypeScript
- 星标
- 261
- 派生
- 561
- 平均合并
- 4 小时 36 分钟
- 30 天内合并 PR
- 16
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
nushell/nushell.github.io 的其他 Issue
-
难度 1/5 1-3 小时 新手友好度 68/100
nushell/nushell.github.io#2081 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 62/100
nushell/nushell.github.io#767 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2232 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 58/100
nushell/nushell.github.io#2209 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
nushell/nushell.github.io#2194 ·
维护者通常 1 天内回复
查看 nushell/nushell.github.io 的全部 Issue
相似的 Issue
-
bug cli service
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
create-element: same editorAlias silent-fallback bug as #201, not covered by that fix可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭generated-by-ai
难度 2/5 1-3 小时 新手友好度 78/100
umbraco/Umbraco-CMS-MCP-Editor#208 · 1 条评论 ·
维护者通常 1 天内回复
-
Table: Space fires onActivate in single-selection mode — the reference doc and the JSDoc disagree未关闭
难度 2/5 1-3 小时 新手友好度 68/100
sidorares/react-x11-components#764 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
backnotprop/plannotator#1840 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
JoviDeCroock/pracht#432 ·
维护者通常 1 天内回复