Docs: Better Callouts for all
/ strict
/ strict-type-checked
Config Stability
#9073
Open
2 tasks done
Labels
documentation
Documentation ("docs") that needs adding/updating
triage
Waiting for maintainers to take a look
Before You File a Documentation Request Please Confirm You Have Done The Following...
Suggested Changes
Currently on the Shared Configs page, there is a small blurb near the top of the page that reads:
However, when a user visits a rule (e.g. no-dynamic-delete ), and clicks on the link to the config and how to add it to their ESLint config, they are taken past this blurb, and may never see it.
The CAUTIONs under the
strict
andstrict-type-checked
configs, as well as the WARNING under theall
config, could be updated, or a new admonishment of some kind (ie a CAUTION or WARNING) could be added to each one, to say essentially the inverse of the blurb at the top, with text such as:This would better call out their not being considered "stable," especially being under an admonishment instead of a blockquote blurb, and make the wording visible as soon as a user arrives at the config from a rule, instead of relying on their scrolling to the top of the page to get the information. Optionally, the blurb could be removed as well.
Affected URL(s)
The text was updated successfully, but these errors were encountered: