mdn / mdn/fred

Browser compat section shows misleading technical keys on pages with multiple BCD queries

Open
#957 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
233
Forks
61
Avg merge
1d 1h
Merged PRs (30d)
82

Description

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/Push_API#browser_compatibility

What specific section or headline is this issue about?

Browser Compatibility

What information was incorrect, unhelpful, or incomplete?

The compat section shows multiple tables to cover each of the interfaces that are part of the push api. However, the autogenerated heading includes the interface's parent key within the browser compatibility database.

This will look to someone unfamiliar with the BCD data like a JavaScript object and member reference. In other words, they might assume they can type api.PushEvent or something similar in their code.

image

What did you expect to see?

Instead of something like "api.PushEvent", I should just see "PushEvent".

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

Readers should not need familiarity with MDN's data storage mechanisms to interpret what's on an MDN page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Browser Compatibility section on the linked Push API page and trace how multiple BCD queries produce their headings. Confirm the current heading includes the parent key, then verify that completed output shows only the interface name, such as "PushEvent", without the misleading prefix.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.