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

docs: add DocBlocks for mdn-data and some <data-type> #134

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

buschtoens
Copy link

Relates to #131.

This PR replicates the docs from mdn-data as DocBlocks and constrains the types a bit more based on the JSON schemas.

It also adds src/data/types.d.ts, which includes DocBlocks and template literal types for most data types. As template literal types are still quite limited, this is only a best-effort approach. The primary issues are:

Actually making use of these template literal types is blocked by #124.

I've already had some of these types laying around from internal source code and thought the least I could to is upstream them here, so that they may get picked up.

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

Successfully merging this pull request may close these issues.

1 participant