Explore using MDN to improve DOM documentation

[mjbvz]

Suggestion

🔍 Search Terms

• mdn
• jsdoc
• quickinfo / hover
• IntelliSense
• lib.dom.d.ts

⭐ Suggestion

When trying to figure out a DOM api, I often find that our built-in documentation isn't enough and that I instead have to go to MDN. It would be great if we could use MDN data to improve our documentation since MDN seems more up to date and more comprehensive than what we have in lib.dom.d.ts.

On the VS Code team, we have previously used MDN for our css and html support:

• Link to MDN API docs from intellisense vscode-html-languageservice#12
• Use MDN data to power the CSS language server vscode-css-languageservice#68

Some ideas to explore:

• Pull in more documentation for types and parameters from MDN (not sure how much the lib-dom generator already does this, but many DOM types currently are missing documentation)

• Add a MDN link to the bottom of documentation

[maccman]

Love this idea!

[its-all-waves]

Yes this would be great! Also, letting us see that in an HTML doc.

[Nima-MM]

So is there any solution? This is for us beginner, very very helpful to get familiar with the language we are working with.
MDN or any kind of explanation of the keyword.

[RyanCavanaugh]

We looked into this a while back and determined that the licensing of the content makes it quite difficult to move it into the .d.ts files. It's under the CC-BY-SA license but we don't have any ergonomic way to comply with the attribution requirements of that license without hugely bloating the size of the relevant files.