Some clarification about what Baseline is and isn't - #3626
Conversation
github-actions
Bot
added
the
documentation
| @@ -1,4 +1,4 @@ | |||
| # [`web-features`](https://github.com/web-platform-dx/web-features): exploring the set of interoperable features of the web platform | |||
There was a problem hiding this comment.
I suggest:
defining the list of features of the web platform and determining their Baseline status
| </a> | ||
|
|
||
| <p> | ||
| Baseline gives you clear information about which web platform features work across browsers. |
There was a problem hiding this comment.
Throughout, this PR replaces "clear" with "summarized." I don't love that.
IMO, the main problem we're referring to in #2783 isn't that people don't realize that Baseline is a summary; it's a false-negative problem. If something is Baseline WA, you can use it, but people might wrongly assume that if something is NA or LA, then you simply can't use it, and you'll just have to wait.
If we all agreed that Baseline wasn't "clear," then I think Baseline wouldn't be useful at all, but I think it is useful because it is clear.
|
|
||
| - **Newly available**: The feature works across the latest devices and browser versions. The feature might not work in older devices or browsers. Indicated with a blue icon. | ||
| - **Widely available**: The feature is well established and works across many devices and browser versions. It’s been available across browsers for at least 2½ years (30 months). Indicated with a green icon. | ||
| Baseline is a simplification of the complex reality of web platform feature support, and it can't replace detailed testing for your specific use case. |
There was a problem hiding this comment.
I think this is too strong a disclaimer,. This makes it sound like Baseline should never replace detailed testing. (And it makes it sound like we encourage all developers to do the tests themselves, rather than rely on BCD.)
I suggest:
Features that aren't yet available in all browsers might still work well enough for your needs, as a progressive enhancement with a fallback, or by using a polyfill or transpiler.
| - **Newly available** | ||
|
|
||
| The feature has recently become available in all the browsers of the core browser set. The feature might not work yet in older devices or browsers. | ||
| This status is indicated with the following blue icon: <img src="/assets/img/baseline-widely-icon.svg" alt="Baseline widely available icon" style="height:1em;">. |
There was a problem hiding this comment.
| This status is indicated with the following blue icon: <img src="/assets/img/baseline-widely-icon.svg" alt="Baseline widely available icon" style="height:1em;">. | |
| This status is indicated with the following blue checkmark with a dotted background : <img src="/assets/img/baseline-widely-icon.svg" alt="Baseline widely available icon" style="height:1em;">. |
| - **Widely available** | ||
|
|
||
| The feature has been available in all the browsers of the core browser set for at least 2½ years (30 months). It is now well established and works across many devices and browser versions. | ||
| This status is indicated with the following green icon: <img src="/assets/img/baseline-newly-icon.svg" alt="Baseline newly available icon" style="height:1em;">. |
There was a problem hiding this comment.
| This status is indicated with the following green icon: <img src="/assets/img/baseline-newly-icon.svg" alt="Baseline newly available icon" style="height:1em;">. | |
| This status is indicated with the following green checkmark with a solid background: <img src="/assets/img/baseline-newly-icon.svg" alt="Baseline newly available icon" style="height:1em;">. |
| This status is indicated with the following green icon: <img src="/assets/img/baseline-newly-icon.svg" alt="Baseline newly available icon" style="height:1em;">. | ||
|
|
||
| Prior to being part of Baseline, a feature has **Limited availability** when it's not yet available across all the browsers of the core browser set. | ||
| Limited availability features are indicated with the following grey and orange icon: <img src="/assets/img/baseline-limited-icon.svg" alt="Limited availability icon" style="height:1em;"> |
There was a problem hiding this comment.
| Limited availability features are indicated with the following grey and orange icon: <img src="/assets/img/baseline-limited-icon.svg" alt="Limited availability icon" style="height:1em;"> | |
| Limited availability features are indicated with the following grey and orange X icon with a solid background: <img src="/assets/img/baseline-limited-icon.svg" alt="Limited availability icon" style="height:1em;"> |
|
Discussed during today's WebDX CG meeting. Leaning towards closing as we have, since then, made a number of updates to the Web site that incorporates some of the changes discussed here. @captainbrosset, are there things worth reporting to another PR before we close? |
4 participants
This is a partial fix to #2783, in particular to this point:
Although this is not a change of the Baseline definition, I feel like the owners group should review this.