Documentation links are broken

[jpryne]

The links to MDN documentation in the RustWasm documentation are (all?) dead.

Steps to Reproduce

1. Go to https://rustwasm.github.io/wasm-bindgen/api/web_sys/struct.WebGpu.html
2. Click on "MDN Documentation"
3. See error

[Pauan]

Thanks for pointing this out! It seems to me that this is expected, since WebGPU is a new API which isn't standardized yet, so I'm not surprised that MDN doesn't have a link to it.

What surprises me is that we're generating bindings for a non-standard API. @alexcrichton Any idea why that's happening?

[jpryne]

Not surprising to me either, seeing as it isn't yet ratified. Still, I'm chomping at the bit to make use of it...

[Pauan]

Still, I'm chomping at the bit to make use of it...

You can make your own bindings for it, so that way you don't need to wait for it to be standardized.

[jpryne]

Yes, I'm tinkering with it via rs-wgpu as well.

[alexcrichton]

Yeah unfortunately we simply manufacture links to MDN without actually validating them. All existing links (or those we've found) follow the same pattern so the links are expected to get filled in over time as APIs are documented.

We could perhaps though have a blacklist in web-sys of APIs that don't have working documentation links and route them elsewhere or say-so inline?

[Pauan]

@alexcrichton In this particular case, I don't think the issue is with the documentation, the issue is that we're generating API bindings at all. The WebGPU API is super unstable, and we've always had the policy of only shipping stable APIs. So there's something deeper wrong going on, maybe with the WebIDL itself.

[alexcrichton]

Ah I see, we didn't vet the WebIDL too closely when we ingested all of it, so existing unstable APIs we pulled in is largely by accident. I'll tag this as a breaking change as well because we'd want to remove support for these APIs

[jpryne]

As a sidenote, what's a realistic timeline for WebGPU to go live?

[Pauan]

@jpryne You can follow the development here. I don't see any concrete timeline listed, but I imagine it will still be a couple years before it's standardized and available.

[L0g4n]

@alexcrichton I just wanted to open an issue because I see broken MDN links on HtmlInputElement for example. E.g. check out https://docs.rs/web-sys/0.3.45/web_sys/struct.HtmlInputElement.html#method.report_validity. But I am sure there are more.