wasm-bindgen icon indicating copy to clipboard operation
wasm-bindgen copied to clipboard

Add list of current unstable APIs to docs

Open epompeii opened this issue 4 years ago • 3 comments

The motivation behind making this change is to increase the discoverability of unstable APIs. The current list has been populated using the contents of wasm-bindgen/crates/web-sys/webidls/unstable/. Going forward, MRs that add or remove unstable APIs will need to update this list accordingly.

epompeii avatar Nov 27 '21 16:11 epompeii

Is there a way this list could be auto-generated? I otherwise will surely forget to ever remind folks to update this when WebIDL changes.

alexcrichton avatar Nov 29 '21 15:11 alexcrichton

Yeah, that would be best! One option is to create an mdbook preprocessor that auto-generates the markdown list based on a given file path. Or I could add a check in the doc_book CI step that validates the list against the contents of wasm-bindgen/crates/web-sys/webidls/unstable/. At the very least this would catch a missed update and prompt the appropriate change.

epompeii avatar Nov 29 '21 17:11 epompeii

Either way is fine by me, either generating this during the doc build or validating on CI the list is correct. Whichever is easiest to compute seems fine by me!

alexcrichton avatar Nov 29 '21 18:11 alexcrichton

Automating this should be easily implementable in the Webidl generator.

daxpedda avatar May 11 '23 17:05 daxpedda