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

Add web developer friendly links to MDN #32

Open
captainbrosset opened this issue Nov 21, 2024 · 0 comments
Open

Add web developer friendly links to MDN #32

captainbrosset opened this issue Nov 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@captainbrosset
Copy link
Contributor

captainbrosset commented Nov 21, 2024

Help wanted: help me complete the mapping between web-features and MDN URLs

The features listed in the web-features repository don't come with MDN URLs.
However, linking web-features to MDN URLs is useful for several things:

  • If the mapping is available somewhere, then consumers of web-features can use the mapping to link the web-features they display to MDN.
    • One example is the State Of surveys, which use web-features, and which also show MDN URLs. This mapping with help there.
    • Another example is this very site: https://web-platform-dx.github.io/web-features-explorer/, which shows MDN links on individual feature pages. This mapping helps show the right links.
  • The other way around is true too. For MDN, which shows baseline badges, having a one-to-one mapping from MDN pages to web-features can help find the right web-features.

The mapping is, for now, maintained in this file: https://github.com/web-platform-dx/web-features-explorer/blob/main/mdnDocsOverrides.json

There are still a couple hundred features left to be mapped. Here's how the mapping works:

{
  "<web-feature-id>": [
    "<MDN-page-slug>"
  ]
}

Each feature points to one or more MDN URL. Each MDN URL is partial, only the slug is needed, not the root URL. Here's an example:

{
  "aborting": [
    "Web/API/AbortController",
    "Web/API/AbortSignal"
  ]
}

The root URL is https://developer.mozilla.org/en-US/docs/, so the two slugs above end up pointing to: https://developer.mozilla.org/en-US/docs/Web/API/AbortController and https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal.

On the web-features-explorer website, currently, the mapping is used to display links as follows:

image

See this page live here: https://web-platform-dx.github.io/web-features-explorer/features/aborting/

@captainbrosset captainbrosset added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant