Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Add a new app badge How-to page to PWA docs #25143
Add a new app badge How-to page to PWA docs #25143
Changes from all commits
60993c4
5b26db8
a8f33fd
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we create a BCD type table at the bottom or is there a BCD for desktop, browser, and PWA support? Either way, should we move the BCD-esque information to where BCD is normally found? I am sure we will hit this a lot as we write these pages, so thinking we should formalize.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is BCD for
setAppBadge()
andclearAppBadge()
:https://developer.mozilla.org/en-US/docs/Web/API/Navigator/setAppBadge#browser_compatibility
https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clearAppBadge#browser_compatibility
This does include the support details that are described in this section of the new page.
I agree that we need a consistent way to represent support in these pages. In #24709 I already complained about using the
browser-compat
key, on the basis that this isn't a reference doc, but I wonder whether this isn't pointlessly pedantic. We could have a "Compatibility" or "Browser compatibility" H2, but instead of tables, have links to compat for any web platform features discussed, like:I think there might be some aspects of compat that are hard to capture in BCD, like which browsers support installation at all or which manifest members are mandatory for installation.
I'm going to ask for more opinions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we need a consistent way to go about this, so that all pages of the same type are the same.
Also, having to write prose for which browsers support a given How-to is going to be hard to maintain.
I had originally added BCD tables in another PR for a PWA How-to page, but Will and I discussed and decided to remove them.
I don't think having BCD tables, as they exist today, is the right option for How-to pages. Say I want to write a How-to about downloading movie files for offline viewing in a PWA. The page will reference multiple technologies such as Streams, IndexedDB, Service Workers, and others. Adding BCD tables for all of them would be messy. This will result in a big wall of, potentially unnecessary, information.
We'd almost want to have a tool, based on BCD, that you can configure to spit out a custom BCD table that only contains what you need for a given page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a link to an article about engagement would be fabulous here, if there is a good one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have two alternative for these H3s: either add a link for more information on each, or leave as is and combine them into a
<dl>
of good UX suggestions.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't really find a link about engagement that I wouldn't have to pick at random. If anyone knows a good one, I'm happy to add it.
Regarding using a
<dl>
, I started adding more content to some of these h3 sections. I'm wondering if it's better to use h3s or dls for longer content.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a note about updating as the number of unread messages goes down, not just at zero? That's not really 'how to', more adding hints to good UI practices.