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 · 3 comments
Open

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

tidoust opened this issue Sep 19, 2024 · 3 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

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

4 participants