-
Notifications
You must be signed in to change notification settings - Fork 30k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Inconsistent styling of deprecated items #20841
Comments
@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 |
@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 |
Sure, I'll make a few. |
should this remain open? |
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_ENCODING
andcrypto.fips
are both deprecated, but are not highlighted as such, unlikecrypto.createCipher
which is.There may be other instances of this throughout all of the documentation, but these are the first ones I noticed.
The text was updated successfully, but these errors were encountered: