Skip to content

Add documentation for types and their members #122

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

Closed
srujzs opened this issue Dec 7, 2023 · 3 comments
Closed

Add documentation for types and their members #122

srujzs opened this issue Dec 7, 2023 · 3 comments

Comments

@srujzs
Copy link
Contributor

srujzs commented Dec 7, 2023

We should likely fetch data from the MDN and auto-annotate IDL types.

@parlough
Copy link
Member

parlough commented Dec 7, 2023

Another thing I'd really like to see is surfacing browser support or baseline information on the API docs. This past week they adjusted the baseline definition to have "Newly available" and "Widely available" as well. They have an npm package to access this data.

Eventually this could even be used to add something like support metadata/annotations to the generated members. Then we could have a lint (or similar) that triggers on any unguarded usage of an API that's not in the "Widely available" category, or at least "Newly available".

@devoncarew
Copy link
Member

The data from the web-features npm package looks like a better source of feature info than the web-specs one I started pulling from (#111).

@devoncarew
Copy link
Member

This is mostly done; we can track remaining work / improvements in more specific issues (eg. #190).

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

3 participants