w3c/mdn-spec-links

MDN Spec Links – Linking specs to MDN and browser-support data

MDN Spec Links

This space holds JSON data for individual specs; the per-spec data maps fragment IDs from a particular spec to MDN articles which have Specifications sections that contain links to that spec and fragment ID.

• .mdn-spec-links.ts: TypeScript declaration defining the datatypes and structure of the JSON data
• .mdn-spec-links.schema.json: JSON Schema with the same definitions, generated from the TypeScript

All data here is generated. So you don’t want to edit the data directly; rather, edit https://github.com/mdn/browser-compat-data data upstream, and https://developer.mozilla.org/docs/Web article content.

To regenerate the data, just type make. To build from local BCD and MDN clones:

BCD_REPO=/path/to/mdn/browser-compat-data MDN_REPO=/path/to/mdn/content make -e

mdn-spec-links's Issues

feature-name and slug differ for all pseudo-classes/elements

The keys used in the bcd data structures are clearly optimized for JS usage, and so non-JS-ident characters, such as :, are stripped. They're retained in the actual URLs, tho, which are used to determine the slugs.

As a result, every single pseudo-class and pseudo-element currently triggers the "mismatched between feature name and MDN url" warning in Bikeshed; Selectors in particular is wrecked by this.

I can hack around this in Bikeshed, but since this repo is massaging the data into a flatter format anyway (and thus the feature name doesn't need to correspond to the bcd data structures), maybe we can just fix this here? Specifically, if the only difference between the feature name and the slug name is the presence of :, then change the feature name to match the slug name, so they both have :.

Schema or TypeScript declaration for data

It was a bit difficult to figure out from code and data files what all fields are there, so I created this TypeScript declaration:

interface MdnData {
  [id: string]: MdnEntry[];
}

interface MdnEntry {
  engines: string[];
  filename: string;
  name: string;
  slug: string;
  summary: string;
  support: {
    [browser: string]: {
      version_added: string | boolean | null;
      version_removed?: string;
      notes?: string;
    };
  };
  title: string;
}

I also generated a JSON schema at https://app.quicktype.io?share=5792So9xCL3hM0e2XhUo.

Maybe we can add this to wiki or docs?

Question:

• Why is the following an array? Are there any instances where it has a length more than 1?
  

  mdn-spec-links/appmanifest.json

  Lines 2 to 3 in 0f0d35f

  	"the-display-mode-media-feature": [
  	{

• Did I miss anything in the declaration?

css-contain missing

The list is currently missing the spec. link for CSS Contain 1 causing Bikeshed to spit out a fatal error.

Sebastian

Fetch specifications data from SpecData.json

The specifications used in the Specifications sections of the MDN articles use the data from https://github.com/mdn/kumascript/blob/master/macros/SpecData.json.

Maybe the data to generate the specification links could also be fetched from there? Or the specs could be added directly to the features in the browser-compat-data. I saw you've already done that for the JS features in mdn/browser-compat-data#2983, @sideshowbarker.

Sebastian

Lots of specs in specmap missing in the actual repo

A lot of specs present in SPECMAP.json are missing from the actual repository. For example, the specmap lists both css-values-3.json and css-values-4.json, but both are missing (only css-values.json exists).

This is causing fatal errors in Bikeshed specs :(

IndexedDB missing MDN panels for IDBKeyRange/lowerBound and IDBKeyRange/upperBound

@sideshowbarker - I bet you can help here...

dfns here, which seem fine:

• https://github.com/w3c/IndexedDB/blob/main/index.bs#L4150
• https://github.com/w3c/IndexedDB/blob/main/index.bs#L4165
• https://github.com/w3c/IndexedDB/blob/main/index.bs#L4182
• https://github.com/w3c/IndexedDB/blob/main/index.bs#L4198

All of these MDN pages exist:

• https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange/only
• https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange/upperBound
• https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange/lowerBound
• https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange/bound

I suspect the fault lies in:

https://w3c.github.io/mdn-spec-links/indexeddb-3.json

which has keys for:

• "dom-idbkeyrange-only"
• "dom-idbkeyrange-lowerbound-lower-open-lower"
• "dom-idbkeyrange-upperbound-upper-open-upper"
• "dom-idbkeyrange-bound"

Note how some of those have extra stuff (arguments), which correspond to the missing MDN panels - is this something in MDN that's causing the JSON generation to go wonky? Or something in the tooling here?

Get this auto-updated using a cron job on Travis CI

Seems like the logical next step :). @foolip has some expertise here.