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: Directly reference upstream spec for each item in webgpu.h #473

Open
kainino0x opened this issue Dec 21, 2024 · 0 comments
Open

Docs: Directly reference upstream spec for each item in webgpu.h #473

kainino0x opened this issue Dec 21, 2024 · 0 comments
Labels
non-breaking Does not require a breaking change (that would block V1.0)

Comments

@kainino0x
Copy link
Collaborator

Either with a link to the JS spec, or by embedding documentation from the spec into the generated header.

Originally posted by @kainino0x in #25 (comment):

Apr 11 meeting:

  • doc jam - how should we do this?
  • KN: add links to spec in yaml?
    • pull text from it at codegen time? (but the names will differ)
    • or just generate links to the spec?
  • Generator pulling from spec is worth exploring - from html
  • Explore having the spec repo itself generate some parseable (e.g. json) documentation out of the spec, similar to what types generator does today — then use this for both typescript and C
@kainino0x kainino0x added the non-breaking Does not require a breaking change (that would block V1.0) label Dec 21, 2024
@kainino0x kainino0x changed the title Directly reference upstream spec for each item in webgpu.h Docs: Directly reference upstream spec for each item in webgpu.h Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
non-breaking Does not require a breaking change (that would block V1.0)
Projects
None yet
Development

No branches or pull requests

1 participant