Repository navigation
Inconsistent styling of deprecated items #20841
Description
Activity
@nodejs/documentation @nodejs/website
I think we should add the red bars and red labels wherever we missed to add them, but would love to get @vsemozhetbyt's thoughts on this.
Red labels in TOCs are added automatically by the doc script. To get red bars we just need this blockquote element straight after a heading or a YAML block (if it is present):
> Stability: 0 - Deprecated[: More info if needed.]As for where they should be added, maybe we need to check
deprecations.mdagainst all other docs + maybe to grep "deprecated" in all docs. Not sure, but maybe this is appropriate for the first good issues or Code-and-learn sessions?@Trott maybe we could use a few of these for https://www.nodetodo.org/?
@Trott maybe we could use a few of these for https://www.nodetodo.org/?
Sure! (Although I bet they will be grabbed faster if you open an issue for each one and label it
good first contribution.)Sure, I'll make a few.
should this remain open?
- added a commit that references this issue
on Oct 19, 2018 - added a commit that references this issue
on Oct 20, 2018 - added a commit that references this issue
on Oct 21, 2018 - added a commit that references this issue
on Oct 30, 2018 - added a commit that references this issue
on Nov 28, 2018 - added a commit that references this issue
on Nov 29, 2018 - added a commit that references this issue
on Jul 27, 2026
There are some places in the documentation where deprecated items are not especially highlighted/styled as being deprecated, whereas others have both the red 'deprecated' label in the outline at the top of the page and the big red bar in the actual description. This is the case, no matter what level of deprecation is involved (doc-only, runtime, etc.).
For example:
crypto.DEFAULT_ENCODINGandcrypto.fipsare both deprecated, but are not highlighted as such, unlikecrypto.createCipherwhich is.There may be other instances of this throughout all of the documentation, but these are the first ones I noticed.