nushell / nushell/nushell.github.io
Add "Warning/Tip" to top of older Release Notes that they might have outdated info
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Release Notes covering the fifth-oldest release and earlier, then check how the theme represents a warning header. Apply the proposed outdated-information notice to the qualifying notes without rewriting their historical content. Done means the older notes display the warning consistently while newer Release Notes remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100