Skip to content
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

Avoid targeting YML files in "Learn more" links #17

Open
tidoust opened this issue Sep 19, 2024 · 8 comments
Open

Avoid targeting YML files in "Learn more" links #17

tidoust opened this issue Sep 19, 2024 · 8 comments

Comments

@tidoust
Copy link
Member

tidoust commented Sep 19, 2024

Reviewing the proposal to add a quick lookup to the Baseline landing page in web-platform-dx/web-features#1800 makes me realize that the "Learn more" link is a bit abrupt: it takes me to a YML data file when I would rather have expected to, well, learn more about the feature in a more digestable way.

Since the group also maintains a Web Features explorer, one idea could be to link to the page that describes the feature in the explorer, for example, for appearance, link could be to https://web-platform-dx.github.io/web-features-explorer/features/appearance/ instead of to https://github.com/web-platform-dx/web-features/blob/main/features/appearance.yml

An alternative could be to link to a relevant page on MDN, but not all features have MDN pages.

(cc @captainbrosset)

@atopal
Copy link
Collaborator

atopal commented Sep 19, 2024

Yes, that was not the intention. The intention to give more info about Baseline and now that we have a landing page for it, it would link to the landing page.

@captainbrosset
Copy link

Linking to the baseline landing page seems like the right default thing to do. I would also suggest making the link customizable via the component API surface. While existing consumers want to link to information about baseline, other future consumers might want to link to places to learn more about that particular feature.

@voxpelli
Copy link

If one could link the <h1> (or if its changed as asked in #28) as well that would be nice – my initial reaction was to try clicking the title and thinking I would end up at the MDN page for the feature, then when I found out it wasn't linked I clicked the "Learn more" and experienced this

@bramus
Copy link
Contributor

bramus commented Dec 11, 2024

We - Chrome CSS and UI DevRel - have rolled out the widget on https://chrome.dev/css-wrapped-2024/ and have received several reports from users that the "Learn More" link is totally useless.

I can't say I disagree with them.

Short term solutions:

  • Remove the link
  • Rename the link to "Data Source" or something like that
  • Replace the link with "Learn more about Baseline" (but personally I would find that less useful)

Long term solutions:

  • Update all entries so that they link to, for example, the MDN page on the topic.

@captainbrosset
Copy link

Update all entries so that they link to, for example, the MDN page on the topic.

This file helps map between web-feature IDs and MDN pages: https://github.com/web-platform-dx/web-features-explorer/blob/main/mdnDocsOverrides.json

@argyleink
Copy link
Contributor

I wish it took me straight to caniuse. A good example here is paint-order

Screenshot 2024-12-11 at 7 30 34 AM

it's all checks.. but says it's limited? clicks expando details arrow

Screenshot 2024-12-11 at 7 30 25 AM

but why? so clicks learn more

Screenshot 2024-12-11 at 7 30 47 AM

this lack of transparency about the "limited" feature label hurts adoption

@captainbrosset
Copy link

That's a very good point Adam. Turns out the feature is not supported on Safari for iOS, but the baseline status component doesn't show that!

I think we should take that particular point out and into its own separate issue (I'll create it soon).

@argyleink is your suggestion to link to caniuse something you'd want specifically for this one feature (because of the weird limited+green state)? Or something you think would be useful in all cases?

@argyleink
Copy link
Contributor

@argyleink is your suggestion to link to caniuse something you'd want specifically for this one feature (because of the weird limited+green state)? Or something you think would be useful in all cases?

useful in all cases for when someone wants to dig in deeper for more specifics or more browsers compared (like mobile). but maybe "Learn more" should go to MDN, and a "CanIuse" link that goes to caniuse?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants