Documentation for web platform features becoming widely available in 2024
Elchi3 opened this issue · 2 comments
Problem statement
The WebDX group has created an approximation called "Baseline - high" that determines if a feature will be widely available to web developers.
Several web platform features implemented in recent years will reach this state within 2024. It would be good if we could guarantee that the 2024 Baseline high features are properly documented. Web developers want to learn about these features.
Proposed solutions
According to BCD's current data there are about 635 features that, within 2024, will newly be considered "Baseline high".
We should have a little checkup on the docs for these.
- Do we have a reference page and is it good?
- Do we need a guide for the feature/the feature set?
- Make sure the features are tagged properly and have a baseline banner to spread the good news about their newly state of "widely supported".
As BCD's data improves, 635 might not be the exact number of features, but we can re-query BCD later in the year to double-check. A spreadsheet that contains the list of features is here: https://docs.google.com/spreadsheets/d/1mBF49ZqtE_uZ58hR0xlb1uygqE7DOWuTHVaMLZd8auo/edit?resourcekey=0-yopuDeseph8VO-StzYjuBQ#gid=1238114670
Task list
- Take a look at the list of features and group them.
- Agree on checkup criteria/level of improvement/doc quality we want to see for these
- Update/write the docs
- Double-check the list against BCD later in the year to see if there is more
Priority assessment
- Effort: Large
- Dependencies: None.
- Community enablement: We can share this project with anyone who wants to help.
- Momentum: High. People will talk about these features in 2024 very likely.
- Enabling learners: n/a
- Enabling professionals: n/a
- Underrepresented topics / Ethical web: n/a
- Operational necessities: n/a
- Addressing needs of the web industry: I reckon it is good to show how newly, widely available features can be used on the web platform to do cool things.
More information
Open Web Docs (OWD) is a non-profit collective funded by corporate and individual donations.
In order for this project to happen, please consider donating to OWD on https://opencollective.com/open-web-docs.
For more information on sponsorship and membership tiers, see https://openwebdocs.org/membership/
More information is available at https://openwebdocs.org/.
For questions, please reach out to florian@openwebdocs.org.
We might want to break down this project and look at groups of features from the spreadsheet. For example:
- AbortSignal
- AuthenticatorResponse
- BroadcastChannel
- HTMLDialogElement
- WebGL 2
- Lock API
- MediaSession
- NavigationPrelooadManager
- PerformanceNavigationTiming
- PublicKeyCredential
- RTC API improvements
- ReadableStream/WritableStream/TransformStream
- ResizeObserverSize
- StorageManager
- VisualViewport
- Enhanced ImageBitmaps
- CSS Layers
- CSS cursor property
- CSS Masks
- More CSS scroll properties
- More CSS text properties
- SharedArrayBuffer and Atomics
- BigInt64Arrays
- Private Class fields
- (a lot of misc features on their own)
I'm closing this project proposal for now. We haven't had the capacity to check the quality of the documentation for features that received a "baseline high" status in 2024. We can reopen this issue if we think this is a priority again.
In the meantime, we discover entirely undocumented APIs on https://openwebdocs.github.io/web-docs-backlog/. This work is probably higher priority for now than fixing up existing reference pages.