Skip to content

Commit ae5b544

Browse files
docs: Better Baseline comms in use-baseline.md (#102)
This change clarifies what Baseline is, also changes a few of the links to point to the WebDX CG site instead of web.dev, and also adds content about how developers should think about the warnings raised by the rule. Fixes #80
1 parent fda2c8e commit ae5b544

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/rules/use-baseline.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,21 @@ Enforce the use of baseline features
44

55
## Background
66

7-
[Baseline](https://web.dev/baseline) is an effort by the [W3C WebDX Community Group](https://github.com/web-platform-dx) to document which features are available in four core browsers: Chrome (desktop and Android), Edge, Firefox (desktop and Android), and Safari (macOS and iOS). This data allows developers to choose the technologies that are best supported for their audience. As part of this effort, Baseline tracks which CSS features are available in which browsers.
7+
[Baseline](https://web-platform-dx.github.io/web-features/) is an effort by the [W3C WebDX Community Group](https://www.w3.org/community/webdx/) to document which features of the web platform are available in a [set of core browsers](https://web-platform-dx.github.io/web-features/#:~:text=using%20the%20following-,core%20browser%20set,-%3A) (currently composed of Chrome, Chrome for Android, Edge, Firefox, Firefox for Android, Safari, and Safari for iOS). The Baseline data allows developers to make quicker decisions about the technologies they wish to use on their websites.
88

9-
Features are grouped into three levels:
9+
Baseline tracks features that cover the entire web platform, including features that are about CSS properties, values, or selectors. This rule uses the Baseline data from these CSS-related features.
1010

11-
- **Widely available** features are those supported by all core browsers for at least 30 months.
12-
- **Newly available** features are those supported by all core browsers for less than 30 months.
13-
- **Limited availability** features are those supported by some but not all core browsers.
11+
Features tracked by Baseline can be in either of these three stages:
1412

15-
Generally speaking, it's preferable to stick to widely available features to ensure the greatest interoperability across browsers.
13+
- **Widely available** features are supported by all the core browsers for at least 30 months.
14+
- **Newly available** features are supported by all the core browsers for less than 30 months.
15+
- **Limited availability** features are not yet supported by all the core browsers.
16+
17+
While using only Baseline widely available features can help ensure the greatest interoperability across browsers, note that:
18+
19+
- Testing your site is still required, especially if your audience uses browsers other than the Baseline core browser set.
20+
- Testing how accessible your site is with assistive technologies is still required. Baseline does not track how assistive technologies support web platform features.
21+
- You might still want to use non-widely available features, for example as part of a progressive enhancement strategy, using the `@supports` rule, or by defining fallbacks, or because of the browsers or devices your audience uses.
1622

1723
## Rule Details
1824

@@ -88,13 +94,13 @@ h1:has(+ h2) {
8894
This rule accepts an option object with the following properties:
8995

9096
- `available` (default: `"widely"`)
91-
- change to `"newly"` available to allow features that have had cross-browser support for fewer than 30 months
92-
- set to a numeric baseline year, for which all features that became baseline that year or earlier should be allowed (example: `2023`)
97+
- change to `"newly"` to allow features that are at the Baseline newly available stage: features that have been supported on all core browsers for less than 30 months
98+
- set to a numeric baseline year, such as `2023`, to allow features that became Baseline newly available that year, or earlier
9399

94100
## When Not to Use It
95101

96102
If your web application doesn't target all Baseline browsers then you can safely disable this rule.
97103

98104
## Further Reading
99105

100-
- [How do things become baseline?](https://web.dev/baseline#how-do-things-become-baseline)
106+
- [How do features become part of Baseline?](https://web-platform-dx.github.io/web-features/#how-do-features-become-part-of-baseline%3F)

0 commit comments

Comments
 (0)